Instrument Neutral Distributed Interface INDI  1.9.5
deepskydad_af1.h
Go to the documentation of this file.
1 /*
2  Deep Sky Dad AF1
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  DeepSkyDadAF1();
35  virtual ~DeepSkyDadAF1() override = default;
36 
37  typedef enum { FULL, HALF, QUARTER, EIGHT } FocusStepMode;
38 
41 
42  const char * getDefaultName() override;
43  virtual bool initProperties() override;
44  virtual bool updateProperties() override;
45  virtual bool ISNewSwitch(const char * dev, const char * name, ISState * states, char * names[], int n) override;
46  virtual bool ISNewNumber(const char * dev, const char * name, double values[], char * names[], int n) override;
47 
48  static void timedMoveHelper(void * context);
49  protected:
50  /*
51  * @brief Handshake Try to communicate with Focuser and see if there is a valid response.
52  * @return True if communication is successful, false otherwise.
53  */
54  virtual bool Handshake() override;
55 
63  virtual IPState MoveFocuser(FocusDirection dir, int speed, uint16_t duration) override;
64 
70  virtual IPState MoveAbsFocuser(uint32_t targetTicks) override;
71 
78  virtual IPState MoveRelFocuser(FocusDirection dir, uint32_t ticks) override;
79 
80  virtual bool SyncFocuser(uint32_t ticks) override;
81  virtual bool ReverseFocuser(bool enabled) override;
82  virtual bool AbortFocuser() override;
83  virtual void TimerHit() override;
84  virtual bool saveConfigItems(FILE * fp) 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 readPosition();
102  bool readMaxPosition();
103  bool readMaxMovement();
104  bool readSettleBuffer();
105  bool readIdleCoilsTimeout();
106  bool readCoilsMode();
107  bool readCurrentMove();
108  bool readCurrentHold();
109  bool isMoving();
110 
111  void timedMoveCallback();
112 
113  bool MoveFocuser(uint32_t position);
114 
115 
116  double targetPos { 0 }, lastPos { 0 };
117 
118 
119  // Step modes
120  ISwitch StepModeS[4];
121  ISwitchVectorProperty StepModeSP;
122 
123  // Coils mode
124  ISwitch CoilsModeS[3];
125  ISwitchVectorProperty CoilsModeSP;
126 
127  //Current move
128  ISwitch CurrentMoveS[4];
129  ISwitchVectorProperty CurrentMoveSP;
130 
131  //Current hold
132  ISwitch CurrentHoldS[4];
133  ISwitchVectorProperty CurrentHoldSP;
134 
135  // Max movement
136  INumber FocusMaxMoveN[1];
137  INumberVectorProperty FocusMaxMoveNP;
138 
139  // Settle buffer
140  INumber SettleBufferN[1];
141  INumberVectorProperty SettleBufferNP;
142 
143  // Idle coils timeout (ms)
144  INumber IdleCoilsTimeoutN[1];
145  INumberVectorProperty IdleCoilsTimeoutNP;
146 
147  // Response Buffer
148 
149  static const uint8_t DSD_RES { 32 };
150  static const char DSD_DEL { ')' };
151  static const uint8_t DSD_TIMEOUT { 3 };
152 };
DeepSkyDadAF1::ALWAYS_ON
@ ALWAYS_ON
Definition: deepskydad_af1.h:39
DeepSkyDadAF1::QUARTER
@ QUARTER
Definition: deepskydad_af1.h:37
DeepSkyDadAF1::ISNewSwitch
virtual bool ISNewSwitch(const char *dev, const char *name, ISState *states, char *names[], int n) override
Process the client newSwitch command.
Definition: deepskydad_af1.cpp:478
cmd
__u8 cmd[4]
Definition: pwc-ioctl.h:4
DeepSkyDadAF1::ISNewNumber
virtual bool ISNewNumber(const char *dev, const char *name, double values[], char *names[], int n) override
Process the client newNumber command.
Definition: deepskydad_af1.cpp:669
IPState
IPState
Property state.
Definition: indiapi.h:158
ISwitch
One switch descriptor.
INumber
One number descriptor.
DeepSkyDadAF1::updateProperties
virtual bool updateProperties() override
updateProperties is called whenever there is a change in the CONNECTION status of the driver....
Definition: deepskydad_af1.cpp:111
DeepSkyDadAF1::ReverseFocuser
virtual bool ReverseFocuser(bool enabled) override
ReverseFocuser Reverse focuser motion direction.
Definition: deepskydad_af1.cpp:449
DeepSkyDadAF1::SyncFocuser
virtual bool SyncFocuser(uint32_t ticks) override
SyncFocuser Set current position to ticks without moving the focuser.
Definition: deepskydad_af1.cpp:442
DeepSkyDadAF1::Current
Current
Definition: deepskydad_af1.h:40
DeepSkyDadAF1::MoveAbsFocuser
virtual IPState MoveAbsFocuser(uint32_t targetTicks) override
MoveAbsFocuser Move to an absolute target position.
Definition: deepskydad_af1.cpp:816
DeepSkyDadAF1::~DeepSkyDadAF1
virtual ~DeepSkyDadAF1() override=default
indifocuser.h
DeepSkyDadAF1::MoveRelFocuser
virtual IPState MoveRelFocuser(FocusDirection dir, uint32_t ticks) override
MoveRelFocuser Move focuser for a relative amount of ticks in a specific direction.
Definition: deepskydad_af1.cpp:826
DeepSkyDadAF1::AbortFocuser
virtual bool AbortFocuser() override
AbortFocuser all focus motion.
Definition: deepskydad_af1.cpp:881
_INumberVectorProperty
Number vector property descriptor.
Definition: indiapi.h:317
DeepSkyDadAF1::CURRENT_100
@ CURRENT_100
Definition: deepskydad_af1.h:40
DeepSkyDadAF1::TimerHit
virtual void TimerHit() override
Callback function to be called once SetTimer duration elapses.
Definition: deepskydad_af1.cpp:847
DeepSkyDadAF1
Definition: deepskydad_af1.h:31
DeepSkyDadAF1::getDefaultName
const char * getDefaultName() override
Definition: deepskydad_af1.cpp:156
DeepSkyDadAF1::Handshake
virtual bool Handshake() override
perform handshake with device to check communication
Definition: deepskydad_af1.cpp:143
DeepSkyDadAF1::IDLE_OFF
@ IDLE_OFF
Definition: deepskydad_af1.h:39
DeepSkyDadAF1::MoveFocuser
virtual IPState MoveFocuser(FocusDirection dir, int speed, uint16_t duration) override
MoveFocuser Move focuser in a specific direction and speed for period of time.
Definition: deepskydad_af1.cpp:784
DeepSkyDadAF1::CURRENT_50
@ CURRENT_50
Definition: deepskydad_af1.h:40
DeepSkyDadAF1::CURRENT_25
@ CURRENT_25
Definition: deepskydad_af1.h:40
DeepSkyDadAF1::FULL
@ FULL
Definition: deepskydad_af1.h:37
name
const char * name
Definition: indiserver.c:116
DeepSkyDadAF1::CURRENT_75
@ CURRENT_75
Definition: deepskydad_af1.h:40
DeepSkyDadAF1::saveConfigItems
virtual bool saveConfigItems(FILE *fp) override
saveConfigItems Saves the Device Port and Focuser Presets in the configuration file
Definition: deepskydad_af1.cpp:886
INDI::FocuserInterface::FocusDirection
FocusDirection
Definition: indifocuserinterface.h:66
ISState
ISState
Switch state.
Definition: indiapi.h:148
INDI::Focuser
Definition: indifocuser.h:43
DeepSkyDadAF1::IDLE_COILS_TIMEOUT
@ IDLE_COILS_TIMEOUT
Definition: deepskydad_af1.h:39
DeepSkyDadAF1::EIGHT
@ EIGHT
Definition: deepskydad_af1.h:37
DeepSkyDadAF1::CoilsMode
CoilsMode
Definition: deepskydad_af1.h:39
DeepSkyDadAF1::FocusStepMode
FocusStepMode
Definition: deepskydad_af1.h:37
DeepSkyDadAF1::DeepSkyDadAF1
DeepSkyDadAF1()
Definition: deepskydad_af1.cpp:38
DeepSkyDadAF1::timedMoveHelper
static void timedMoveHelper(void *context)
Definition: deepskydad_af1.cpp:798
DeepSkyDadAF1::initProperties
virtual bool initProperties() override
Initilize properties initial state and value. The child class must implement this function.
Definition: deepskydad_af1.cpp:43
DeepSkyDadAF1::HALF
@ HALF
Definition: deepskydad_af1.h:37
_ISwitchVectorProperty
Switch vector property descriptor.
Definition: indiapi.h:365