TwiceAsNice  2019-02-18
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
Gemini Class Reference

#include <gemini.h>

Inheritance diagram for Gemini:
Inheritance graph
Collaboration diagram for Gemini:
Collaboration graph

Public Types

enum  {
  FOCUS_A_COEFF, FOCUS_B_COEFF, FOCUS_C_COEFF, FOCUS_D_COEFF,
  FOCUS_E_COEFF, FOCUS_F_COEFF
}
 
enum  {
  STATUS_MOVING, STATUS_HOMING, STATUS_HOMED, STATUS_FFDETECT,
  STATUS_TMPPROBE, STATUS_REMOTEIO, STATUS_HNDCTRL, STATUS_REVERSE,
  STATUS_UNKNOWN
}
 
enum  { GOTO_CENTER, GOTO_HOME }
 
enum  DeviceType { DEVICE_FOCUSER, DEVICE_ROTATOR }
 
- Public Types inherited from INDI::Focuser
enum  { CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }
 
enum  { CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }
 
- Public Types inherited from INDI::BaseDevice
enum  INDI_ERROR {
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4,
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4
}
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15),
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...
 
enum  INDI_ERROR {
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4,
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4
}
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15),
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...
 
- Public Types inherited from INDI::FocuserInterface
enum  FocusDirection { FOCUS_INWARD, FOCUS_OUTWARD, FOCUS_INWARD, FOCUS_OUTWARD }
 
enum  { FOCUSER_CAN_ABS_MOVE = 1 << 0, FOCUSER_CAN_REL_MOVE = 1 << 1, FOCUSER_CAN_ABORT = 1 << 2, FOCUSER_HAS_VARIABLE_SPEED = 1 << 3 }
 
enum  FocusDirection { FOCUS_INWARD, FOCUS_OUTWARD, FOCUS_INWARD, FOCUS_OUTWARD }
 
enum  { FOCUSER_CAN_ABS_MOVE = 1 << 0, FOCUSER_CAN_REL_MOVE = 1 << 1, FOCUSER_CAN_ABORT = 1 << 2, FOCUSER_HAS_VARIABLE_SPEED = 1 << 3 }
 
- Public Types inherited from INDI::RotatorInterface
enum  { ROTATOR_CAN_ABORT = 1 << 0, ROTATOR_CAN_HOME = 1 << 1, ROTATOR_CAN_SYNC = 1 << 2, ROTATOR_CAN_REVERSE = 1 << 3 }
 
enum  { ROTATOR_CAN_ABORT = 1 << 0, ROTATOR_CAN_HOME = 1 << 1, ROTATOR_CAN_SYNC = 1 << 2, ROTATOR_CAN_REVERSE = 1 << 3 }
 

Public Member Functions

 Gemini ()
 
 ~Gemini ()
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override
 Process the client newSwitch command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override
 Process the client newSwitch command. More...
 
- Public Member Functions inherited from INDI::Focuser
 Focuser ()
 
virtual ~Focuser ()
 
virtual void ISGetProperties (const char *dev)
 define the driver's properties to the client. More...
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
void setSupportedConnections (const uint8_t &value)
 setConnection Set Focuser connection mode. More...
 
uint8_t getSupportedConnections () const
 
 Focuser ()
 
virtual ~Focuser ()
 
virtual void ISGetProperties (const char *dev)
 define the driver's properties to the client. More...
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
void setSupportedConnections (const uint8_t &value)
 setConnection Set Focuser connection mode. More...
 
uint8_t getSupportedConnections () const
 
- Public Member Functions inherited from INDI::DefaultDevice
 DefaultDevice ()
 
virtual ~DefaultDevice ()
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
virtual const char * getDriverName ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion ()
 
uint16_t getMinorVersion ()
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface ()
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. More...
 
 DefaultDevice ()
 
virtual ~DefaultDevice ()
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
virtual const char * getDriverName ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion ()
 
uint16_t getMinorVersion ()
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface ()
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. More...
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 
- Public Member Functions inherited from INDI::FocuserInterface
uint32_t GetCapability () const
 GetFocuserCapability returns the capability of the focuser. More...
 
void SetCapability (uint32_t cap)
 FI::SetCapability sets the focuser capabilities. More...
 
bool CanAbsMove ()
 
bool CanRelMove ()
 
bool CanAbort ()
 
bool HasVariableSpeed ()
 
uint32_t GetCapability () const
 GetFocuserCapability returns the capability of the focuser. More...
 
void SetCapability (uint32_t cap)
 FI::SetCapability sets the focuser capabilities. More...
 
bool CanAbsMove ()
 
bool CanRelMove ()
 
bool CanAbort ()
 
bool HasVariableSpeed ()
 
- Public Member Functions inherited from INDI::RotatorInterface
uint32_t GetCapability () const
 GetRotatorCapability returns the capability of the Rotator. More...
 
void SetCapability (uint32_t cap)
 SetRotatorCapability sets the Rotator capabilities. More...
 
bool CanAbort ()
 
bool CanHome ()
 
bool CanSync ()
 
bool CanReverse ()
 
uint32_t GetCapability () const
 GetRotatorCapability returns the capability of the Rotator. More...
 
void SetCapability (uint32_t cap)
 SetRotatorCapability sets the Rotator capabilities. More...
 
bool CanAbort ()
 
bool CanHome ()
 
bool CanSync ()
 
bool CanReverse ()
 

Protected Member Functions

virtual bool Handshake () override
 perform handshake with device to check communication More...
 
virtual const char * getDefaultName () override
 
virtual bool initProperties () override
 Initilize properties initial state and value. More...
 
virtual bool updateProperties () override
 updateProperties is called whenever there is a change in the CONNECTION status of the driver. More...
 
virtual bool saveConfigItems (FILE *fp) override
 saveConfigItems Saves the Device Port and Focuser Presets in the configuration file More...
 
virtual IPState MoveAbsFocuser (uint32_t targetPosition) override
 MoveFocuser the focuser to an absolute position. More...
 
virtual IPState MoveRelFocuser (FocusDirection dir, uint32_t ticks) override
 MoveFocuser the focuser to an relative position. More...
 
virtual IPState MoveFocuser (FocusDirection dir, int speed, uint16_t duration) override
 MoveFocuser the focuser in a particular direction with a specific speed for a finite duration. More...
 
virtual bool AbortFocuser () override
 AbortFocuser all focus motion. More...
 
virtual void TimerHit () override
 Callback function to be called once SetTimer duration elapses. More...
 
bool ack ()
 
bool isResponseOK ()
 
virtual IPState HomeRotator () override
 HomeRotator Go to home position. More...
 
virtual IPState MoveRotator (double angle) override
 MoveRotator Go to specific angle. More...
 
virtual bool ReverseRotator (bool enabled) override
 ReverseRotator Reverse the direction of the rotator. More...
 
- Protected Member Functions inherited from INDI::Focuser
void processButton (const char *button_n, ISState state)
 
void processButton (const char *button_n, ISState state)
 
- Protected Member Functions inherited from INDI::DefaultDevice
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void debugTriggered (bool enable)
 Inform driver that the debug option was triggered. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. More...
 
bool isDebug ()
 
bool isSimulation ()
 
virtual bool Connect ()
 Connect to the device. More...
 
virtual bool Disconnect ()
 Disconnect from device. More...
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void debugTriggered (bool enable)
 Inform driver that the debug option was triggered. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. More...
 
bool isDebug ()
 
bool isSimulation ()
 
virtual bool Connect ()
 Connect to the device. More...
 
virtual bool Disconnect ()
 Disconnect from device. More...
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
- Protected Member Functions inherited from INDI::BaseDevice
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
- Protected Member Functions inherited from INDI::FocuserInterface
 FocuserInterface (DefaultDevice *defaultDevice)
 
virtual ~FocuserInterface ()=default
 
void initProperties (const char *groupName)
 Initilize focuser properties. More...
 
bool updateProperties ()
 updateProperties Define or Delete Rotator properties based on the connection status of the base device More...
 
bool processNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process focus number properties. More...
 
bool processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process focus switch properties. More...
 
virtual bool SetFocuserSpeed (int speed)
 SetFocuserSpeed Set Focuser speed. More...
 
 FocuserInterface (DefaultDevice *defaultDevice)
 
virtual ~FocuserInterface ()=default
 
void initProperties (const char *groupName)
 Initilize focuser properties. More...
 
bool updateProperties ()
 updateProperties Define or Delete Rotator properties based on the connection status of the base device More...
 
bool processNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process focus number properties. More...
 
bool processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process focus switch properties. More...
 
virtual bool SetFocuserSpeed (int speed)
 SetFocuserSpeed Set Focuser speed. More...
 
- Protected Member Functions inherited from INDI::RotatorInterface
 RotatorInterface (DefaultDevice *defaultDevice)
 
void initProperties (const char *groupName)
 Initilize Rotator properties. More...
 
bool updateProperties ()
 updateProperties Define or Delete Rotator properties based on the connection status of the base device More...
 
bool processNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process Rotator number properties. More...
 
bool processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process Rotator switch properties. More...
 
virtual bool SyncRotator (double angle)
 SyncRotator Set current angle as the supplied angle without moving the rotator. More...
 
virtual bool AbortRotator ()
 AbortRotator Abort all motion. More...
 
 RotatorInterface (DefaultDevice *defaultDevice)
 
void initProperties (const char *groupName)
 Initilize Rotator properties. More...
 
bool updateProperties ()
 updateProperties Define or Delete Rotator properties based on the connection status of the base device More...
 
bool processNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process Rotator number properties. More...
 
bool processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process Rotator switch properties. More...
 
virtual bool SyncRotator (double angle)
 SyncRotator Set current angle as the supplied angle without moving the rotator. More...
 
virtual bool AbortRotator ()
 AbortRotator Abort all motion. More...
 

Protected Attributes

bool focuserConfigurationComplete = false
 
bool rotatorConfigurationComplete = false
 
- Protected Attributes inherited from INDI::Focuser
INumber PresetN [3]
 
INumberVectorProperty PresetNP
 
ISwitch PresetGotoS [3]
 
ISwitchVectorProperty PresetGotoSP
 
Controllercontroller
 
Connection::SerialserialConnection = nullptr
 
Connection::TCPtcpConnection = nullptr
 
int PortFD = -1
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t POLLMS = 1000
 Period in milliseconds to call TimerHit(). Default 1000 ms. More...
 
- Protected Attributes inherited from INDI::FocuserInterface
INumberVectorProperty FocusSpeedNP
 
INumber FocusSpeedN [1]
 
ISwitchVectorProperty FocusMotionSP
 
ISwitch FocusMotionS [2]
 
INumberVectorProperty FocusTimerNP
 
INumber FocusTimerN [1]
 
INumberVectorProperty FocusAbsPosNP
 
INumber FocusAbsPosN [1]
 
INumberVectorProperty FocusRelPosNP
 
INumber FocusRelPosN [1]
 
ISwitchVectorProperty AbortSP
 
ISwitch AbortS [1]
 
uint32_t capability
 
double lastTimerValue = { 0 }
 
DefaultDevicem_defaultDevice { nullptr }
 
- Protected Attributes inherited from INDI::RotatorInterface
INumber GotoRotatorN [1]
 
INumberVectorProperty GotoRotatorNP
 
INumber SyncRotatorN [1]
 
INumberVectorProperty SyncRotatorNP
 
ISwitch AbortRotatorS [1]
 
ISwitchVectorProperty AbortRotatorSP
 
ISwitch HomeRotatorS [1]
 
ISwitchVectorProperty HomeRotatorSP
 
ISwitch ReverseRotatorS [2]
 
ISwitchVectorProperty ReverseRotatorSP
 
uint32_t rotatorCapability = 0
 
DefaultDevicem_defaultDevice { nullptr }
 

Private Member Functions

bool getFocusConfig ()
 
bool getFocusStatus ()
 
bool setFocusPosition (u_int16_t position)
 
bool setTemperatureCompensation (bool enable)
 
bool setTemperatureCompensationMode (char mode)
 
bool setTemperatureCompensationCoeff (char mode, int16_t coeff)
 
bool setTemperatureCompensationOnStart (bool enable)
 
bool setBacklashCompensation (DeviceType type, bool enable)
 
bool setBacklashCompensationSteps (DeviceType type, uint16_t steps)
 
bool home (DeviceType type)
 
bool halt (DeviceType type)
 
bool center (DeviceType type)
 
bool homeOnStart (DeviceType type, bool enable)
 
bool getRotatorConfig ()
 
bool getRotatorStatus ()
 
IPState MoveAbsRotatorTicks (uint32_t targetTicks)
 
IPState MoveAbsRotatorAngle (double angle)
 
bool reverseRotator (bool enable)
 
bool setLedLevel (int level)
 
bool setNickname (DeviceType type, const char *nickname)
 
bool resetFactory ()
 
float calcTimeLeft (timeval, float)
 

Private Attributes

uint32_t focuserSimPosition =0
 
uint32_t rotatorSimPosition =0
 
uint32_t rotatorSimPA =0
 
uint32_t targetFocuserPosition =0
 
uint32_t targetRotatorPosition =0
 
uint32_t targetRotatorAngle =0
 
uint32_t maxControllerTicks =0
 
ISState focuserSimStatus [8]
 
ISState rotatorSimStatus [8]
 
bool simCompensationOn
 
char focusTarget [8]
 
struct timeval focusMoveStart
 
float focusMoveRequest
 
INumber TemperatureN [1]
 
INumberVectorProperty TemperatureNP
 
ISwitch TemperatureCompensateS [2]
 
ISwitchVectorProperty TemperatureCompensateSP
 
ISwitch TemperatureCompensateOnStartS [2]
 
ISwitchVectorProperty TemperatureCompensateOnStartSP
 
INumber TemperatureCoeffN [5]
 
INumberVectorProperty TemperatureCoeffNP
 
ISwitch TemperatureCompensateModeS [5]
 
ISwitchVectorProperty TemperatureCompensateModeSP
 
ISwitch FocuserBacklashCompensationS [2]
 
ISwitchVectorProperty FocuserBacklashCompensationSP
 
INumber FocuserBacklashN [1]
 
INumberVectorProperty FocuserBacklashNP
 
ISwitch FocuserHomeOnStartS [2]
 
ISwitchVectorProperty FocuserHomeOnStartSP
 
ISwitch FocuserGotoS [2]
 
ISwitchVectorProperty FocuserGotoSP
 
ILight FocuserStatusL [8]
 
ILightVectorProperty FocuserStatusLP
 
bool isFocuserAbsolute
 
bool isFocuserHoming
 
ILight RotatorStatusL [8]
 
ILightVectorProperty RotatorStatusLP
 
INumber RotatorAbsPosN [1]
 
INumberVectorProperty RotatorAbsPosNP
 
ISwitch RotatorBacklashCompensationS [2]
 
ISwitchVectorProperty RotatorBacklashCompensationSP
 
INumber RotatorBacklashN [1]
 
INumberVectorProperty RotatorBacklashNP
 
ISwitch RotatorHomeOnStartS [2]
 
ISwitchVectorProperty RotatorHomeOnStartSP
 
bool isRotatorHoming
 
ISwitch ResetS [1]
 
ISwitchVectorProperty ResetSP
 
IText HFocusNameT [2] {}
 
ITextVectorProperty HFocusNameTP
 
INumber LedN [1]
 
INumberVectorProperty LedNP
 
uint32_t DBG_FOCUS
 

Additional Inherited Members

- Static Public Member Functions inherited from INDI::Focuser
static void buttonHelper (const char *button_n, ISState state, void *context)
 
static void buttonHelper (const char *button_n, ISState state, void *context)
 
- Public Attributes inherited from INDI::Focuser
enum INDI::Focuser:: { ... }  FocuserConnection
 
enum INDI::Focuser:: { ... }  FocuserConnection
 
- Public Attributes inherited from INDI::FocuserInterface
enum INDI::FocuserInterface:: { ... }  FocuserCapability
 
enum INDI::FocuserInterface:: { ... }  FocuserCapability
 
- Public Attributes inherited from INDI::RotatorInterface
enum INDI::RotatorInterface:: { ... }  RotatorCapability
 
enum INDI::RotatorInterface:: { ... }  RotatorCapability
 
- Protected Types inherited from INDI::RotatorInterface
enum  { REVERSE_ENABLED, REVERSE_DISABLED }
 
enum  { REVERSE_ENABLED, REVERSE_DISABLED }
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
FOCUS_A_COEFF 
FOCUS_B_COEFF 
FOCUS_C_COEFF 
FOCUS_D_COEFF 
FOCUS_E_COEFF 
FOCUS_F_COEFF 

◆ anonymous enum

anonymous enum
Enumerator
STATUS_MOVING 
STATUS_HOMING 
STATUS_HOMED 
STATUS_FFDETECT 
STATUS_TMPPROBE 
STATUS_REMOTEIO 
STATUS_HNDCTRL 
STATUS_REVERSE 
STATUS_UNKNOWN 

◆ anonymous enum

anonymous enum
Enumerator
GOTO_CENTER 
GOTO_HOME 

◆ DeviceType

Enumerator
DEVICE_FOCUSER 
DEVICE_ROTATOR 

Constructor & Destructor Documentation

◆ Gemini()

Gemini::Gemini ( )

◆ ~Gemini()

Gemini::~Gemini ( )

Member Function Documentation

◆ AbortFocuser()

bool Gemini::AbortFocuser ( )
overrideprotectedvirtual

AbortFocuser all focus motion.

Returns
True if abort is successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

◆ ack()

bool Gemini::ack ( )
protected

◆ calcTimeLeft()

float Gemini::calcTimeLeft ( timeval  start,
float  req 
)
private

◆ center()

bool Gemini::center ( DeviceType  type)
private

◆ getDefaultName()

const char * Gemini::getDefaultName ( )
overrideprotectedvirtual
Returns
Default name of the device.

Implements INDI::DefaultDevice.

◆ getFocusConfig()

bool Gemini::getFocusConfig ( )
private

◆ getFocusStatus()

bool Gemini::getFocusStatus ( )
private

◆ getRotatorConfig()

bool Gemini::getRotatorConfig ( )
private

◆ getRotatorStatus()

bool Gemini::getRotatorStatus ( )
private

◆ halt()

bool Gemini::halt ( DeviceType  type)
private

◆ Handshake()

bool Gemini::Handshake ( )
overrideprotectedvirtual

perform handshake with device to check communication

Reimplemented from INDI::Focuser.

◆ home()

bool Gemini::home ( DeviceType  type)
private

◆ homeOnStart()

bool Gemini::homeOnStart ( DeviceType  type,
bool  enable 
)
private

◆ HomeRotator()

IPState Gemini::HomeRotator ( )
overrideprotectedvirtual

HomeRotator Go to home position.

Returns
State of operation: IPS_OK is motion is completed, IPS_BUSY if motion in progress, IPS_ALERT on error.

Reimplemented from INDI::RotatorInterface.

◆ initProperties()

bool Gemini::initProperties ( )
overrideprotectedvirtual

Initilize properties initial state and value.

The child class must implement this function.

Returns
True if initilization is successful, false otherwise.

Reimplemented from INDI::Focuser.

◆ ISNewNumber()

bool Gemini::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
overridevirtual

Process the client newNumber command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Focuser.

◆ ISNewSwitch()

bool Gemini::ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Focuser.

◆ ISNewText()

bool Gemini::ISNewText ( const char *  dev,
const char *  name,
char *  texts[],
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Focuser.

◆ isResponseOK()

bool Gemini::isResponseOK ( )
protected

◆ MoveAbsFocuser()

IPState Gemini::MoveAbsFocuser ( uint32_t  targetTicks)
overrideprotectedvirtual

MoveFocuser the focuser to an absolute position.

Parameters
ticksThe new position of the focuser.
Returns
Return IPS_OK if motion is completed and focuser reached requested position. Return IPS_BUSY if focuser started motion to requested position and is in progress. Return IPS_ALERT if there is an error.

Reimplemented from INDI::FocuserInterface.

◆ MoveAbsRotatorAngle()

IPState Gemini::MoveAbsRotatorAngle ( double  angle)
private

◆ MoveAbsRotatorTicks()

IPState Gemini::MoveAbsRotatorTicks ( uint32_t  targetTicks)
private

◆ MoveFocuser()

IPState Gemini::MoveFocuser ( FocusDirection  dir,
int  speed,
uint16_t  duration 
)
overrideprotectedvirtual

MoveFocuser the focuser in a particular direction with a specific speed for a finite duration.

Parameters
dirDirection of focuser, either FOCUS_INWARD or FOCUS_OUTWARD.
speedSpeed of focuser if supported by the focuser.
durationThe timeout in milliseconds before the focus motion halts. Pass 0 to move indefinitely.
Returns
Return IPS_OK if motion is completed and focuser reached requested position. Return IPS_BUSY if focuser started motion to requested position and is in progress. Return IPS_ALERT if there is an error.

Reimplemented from INDI::FocuserInterface.

◆ MoveRelFocuser()

IPState Gemini::MoveRelFocuser ( FocusDirection  dir,
uint32_t  ticks 
)
overrideprotectedvirtual

MoveFocuser the focuser to an relative position.

Parameters
dirDirection of focuser, either FOCUS_INWARD or FOCUS_OUTWARD.
ticksThe relative ticks to move.
Returns
Return IPS_OK if motion is completed and focuser reached requested position. Return IPS_BUSY if focuser started motion to requested position and is in progress. Return IPS_ALERT if there is an error.

Reimplemented from INDI::FocuserInterface.

◆ MoveRotator()

IPState Gemini::MoveRotator ( double  angle)
overrideprotectedvirtual

MoveRotator Go to specific angle.

Parameters
angleTarget angle in degrees.
Returns
State of operation: IPS_OK is motion is completed, IPS_BUSY if motion in progress, IPS_ALERT on error.

Implements INDI::RotatorInterface.

◆ resetFactory()

bool Gemini::resetFactory ( )
private

◆ ReverseRotator()

bool Gemini::ReverseRotator ( bool  enabled)
overrideprotectedvirtual

ReverseRotator Reverse the direction of the rotator.

CW is usually the normal direction, and CCW is the reversed direction.

Parameters
enableif True, reverse direction. If false, revert to normal direction.
Returns
True if successful, false otherwise.

Reimplemented from INDI::RotatorInterface.

◆ reverseRotator()

bool Gemini::reverseRotator ( bool  enable)
private

◆ saveConfigItems()

bool Gemini::saveConfigItems ( FILE *  fp)
overrideprotectedvirtual

saveConfigItems Saves the Device Port and Focuser Presets in the configuration file

Parameters
fppointer to configuration file
Returns
true if successful, false otherwise.

Reimplemented from INDI::Focuser.

◆ setBacklashCompensation()

bool Gemini::setBacklashCompensation ( DeviceType  type,
bool  enable 
)
private

◆ setBacklashCompensationSteps()

bool Gemini::setBacklashCompensationSteps ( DeviceType  type,
uint16_t  steps 
)
private

◆ setFocusPosition()

bool Gemini::setFocusPosition ( u_int16_t  position)
private

◆ setLedLevel()

bool Gemini::setLedLevel ( int  level)
private

◆ setNickname()

bool Gemini::setNickname ( DeviceType  type,
const char *  nickname 
)
private

◆ setTemperatureCompensation()

bool Gemini::setTemperatureCompensation ( bool  enable)
private

◆ setTemperatureCompensationCoeff()

bool Gemini::setTemperatureCompensationCoeff ( char  mode,
int16_t  coeff 
)
private

◆ setTemperatureCompensationMode()

bool Gemini::setTemperatureCompensationMode ( char  mode)
private

◆ setTemperatureCompensationOnStart()

bool Gemini::setTemperatureCompensationOnStart ( bool  enable)
private

◆ TimerHit()

void Gemini::TimerHit ( )
overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

◆ updateProperties()

bool Gemini::updateProperties ( )
overrideprotectedvirtual

updateProperties is called whenever there is a change in the CONNECTION status of the driver.

This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.

Returns
True if update is successful, false otherwise.

Reimplemented from INDI::Focuser.

Member Data Documentation

◆ DBG_FOCUS

uint32_t Gemini::DBG_FOCUS
private

◆ FocuserBacklashCompensationS

ISwitch Gemini::FocuserBacklashCompensationS[2]
private

◆ FocuserBacklashCompensationSP

ISwitchVectorProperty Gemini::FocuserBacklashCompensationSP
private

◆ FocuserBacklashN

INumber Gemini::FocuserBacklashN[1]
private

◆ FocuserBacklashNP

INumberVectorProperty Gemini::FocuserBacklashNP
private

◆ focuserConfigurationComplete

bool Gemini::focuserConfigurationComplete = false
protected

◆ FocuserGotoS

ISwitch Gemini::FocuserGotoS[2]
private

◆ FocuserGotoSP

ISwitchVectorProperty Gemini::FocuserGotoSP
private

◆ FocuserHomeOnStartS

ISwitch Gemini::FocuserHomeOnStartS[2]
private

◆ FocuserHomeOnStartSP

ISwitchVectorProperty Gemini::FocuserHomeOnStartSP
private

◆ focuserSimPosition

uint32_t Gemini::focuserSimPosition =0
private

◆ focuserSimStatus

ISState Gemini::focuserSimStatus[8]
private

◆ FocuserStatusL

ILight Gemini::FocuserStatusL[8]
private

◆ FocuserStatusLP

ILightVectorProperty Gemini::FocuserStatusLP
private

◆ focusMoveRequest

float Gemini::focusMoveRequest
private

◆ focusMoveStart

struct timeval Gemini::focusMoveStart
private

◆ focusTarget

char Gemini::focusTarget[8]
private

◆ HFocusNameT

IText Gemini::HFocusNameT[2] {}
private

◆ HFocusNameTP

ITextVectorProperty Gemini::HFocusNameTP
private

◆ isFocuserAbsolute

bool Gemini::isFocuserAbsolute
private

◆ isFocuserHoming

bool Gemini::isFocuserHoming
private

◆ isRotatorHoming

bool Gemini::isRotatorHoming
private

◆ LedN

INumber Gemini::LedN[1]
private

◆ LedNP

INumberVectorProperty Gemini::LedNP
private

◆ maxControllerTicks

uint32_t Gemini::maxControllerTicks =0
private

◆ ResetS

ISwitch Gemini::ResetS[1]
private

◆ ResetSP

ISwitchVectorProperty Gemini::ResetSP
private

◆ RotatorAbsPosN

INumber Gemini::RotatorAbsPosN[1]
private

◆ RotatorAbsPosNP

INumberVectorProperty Gemini::RotatorAbsPosNP
private

◆ RotatorBacklashCompensationS

ISwitch Gemini::RotatorBacklashCompensationS[2]
private

◆ RotatorBacklashCompensationSP

ISwitchVectorProperty Gemini::RotatorBacklashCompensationSP
private

◆ RotatorBacklashN

INumber Gemini::RotatorBacklashN[1]
private

◆ RotatorBacklashNP

INumberVectorProperty Gemini::RotatorBacklashNP
private

◆ rotatorConfigurationComplete

bool Gemini::rotatorConfigurationComplete = false
protected

◆ RotatorHomeOnStartS

ISwitch Gemini::RotatorHomeOnStartS[2]
private

◆ RotatorHomeOnStartSP

ISwitchVectorProperty Gemini::RotatorHomeOnStartSP
private

◆ rotatorSimPA

uint32_t Gemini::rotatorSimPA =0
private

◆ rotatorSimPosition

uint32_t Gemini::rotatorSimPosition =0
private

◆ rotatorSimStatus

ISState Gemini::rotatorSimStatus[8]
private

◆ RotatorStatusL

ILight Gemini::RotatorStatusL[8]
private

◆ RotatorStatusLP

ILightVectorProperty Gemini::RotatorStatusLP
private

◆ simCompensationOn

bool Gemini::simCompensationOn
private

◆ targetFocuserPosition

uint32_t Gemini::targetFocuserPosition =0
private

◆ targetRotatorAngle

uint32_t Gemini::targetRotatorAngle =0
private

◆ targetRotatorPosition

uint32_t Gemini::targetRotatorPosition =0
private

◆ TemperatureCoeffN

INumber Gemini::TemperatureCoeffN[5]
private

◆ TemperatureCoeffNP

INumberVectorProperty Gemini::TemperatureCoeffNP
private

◆ TemperatureCompensateModeS

ISwitch Gemini::TemperatureCompensateModeS[5]
private

◆ TemperatureCompensateModeSP

ISwitchVectorProperty Gemini::TemperatureCompensateModeSP
private

◆ TemperatureCompensateOnStartS

ISwitch Gemini::TemperatureCompensateOnStartS[2]
private

◆ TemperatureCompensateOnStartSP

ISwitchVectorProperty Gemini::TemperatureCompensateOnStartSP
private

◆ TemperatureCompensateS

ISwitch Gemini::TemperatureCompensateS[2]
private

◆ TemperatureCompensateSP

ISwitchVectorProperty Gemini::TemperatureCompensateSP
private

◆ TemperatureN

INumber Gemini::TemperatureN[1]
private

◆ TemperatureNP

INumberVectorProperty Gemini::TemperatureNP
private

The documentation for this class was generated from the following files: