Instrument Neutral Distributed Interface INDI  1.5.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
INDI::Focuser Class Reference

Class to provide general functionality of a focuser device. More...

#include <indifocuser.h>

Inheritance diagram for INDI::Focuser:
INDI::DefaultDevice INDI::FocuserInterface INDI::BaseDevice FocusLynxBase FocusSim Gemini HitecAstroDCFocuser Microtouch MoonLite NFocus NightCrawler NSTEP PerfectStar RoboFocus SmartFocus SteelDrive TCFS USBFocusV3

Public Types

- Public Types inherited from INDI::BaseDevice
- Public Types inherited from INDI::FocuserInterface

Public Member Functions

 Focuser ()
 
virtual ~Focuser ()
 
virtual bool initProperties ()
 Initilize properties initial state and value. The child class must implement this function. More...
 
virtual void ISGetProperties (const char *dev)
 define the driver's properties to the client. Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device. More...
 
virtual bool updateProperties ()
 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. More...
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process the client newNumber command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process the client newSwitch command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
 Process the client newSwitch command. More...
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More...
 
void setFocuserConnection (const uint8_t &value)
 setFocuserConnection Set Focuser connection mode. Child class should call this in the constructor before INDI::Focuser registers any connection interfaces More...
 
uint8_t getFocuserConnection () 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 resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. It will also be deleted from all clients. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (int ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual void TimerHit ()
 Callback function to be called once SetTimer duration elapses. 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. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. 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 ()
 
- Public Member Functions inherited from INDI::FocuserInterface
uint32_t GetFocuserCapability () const
 GetFocuserCapability returns the capability of the focuser. More...
 
void SetFocuserCapability (uint32_t cap)
 SetFocuserCapability sets the focuser capabilities. All capabilities must be initialized. More...
 
bool CanAbsMove ()
 
bool CanRelMove ()
 
bool CanAbort ()
 
bool HasVariableSpeed ()
 

Static Public Member Functions

static void buttonHelper (const char *button_n, ISState state, void *context)
 

Public Attributes

enum INDI::Focuser:: { ... }  FocuserConnection
 
- Public Attributes inherited from INDI::FocuserInterface
enum INDI::FocuserInterface:: { ... }  FocuserCapability
 

Protected Member Functions

virtual bool saveConfigItems (FILE *fp)
 saveConfigItems Saves the Device Port and Focuser Presets in the configuration file More...
 
virtual bool Handshake ()
 perform handshake with device to check communication More...
 
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. Dyanmic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when ┼▒deleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false. 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. This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled. More...
 
bool isDebug ()
 
bool isSimulation ()
 
virtual bool Connect ()
 Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation. More...
 
virtual bool Disconnect ()
 Disconnect from device. More...
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties() More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
virtual const char * getDefaultName ()=0
 
- 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...
 
- Protected Member Functions inherited from INDI::FocuserInterface
 FocuserInterface ()
 
virtual ~FocuserInterface ()
 
void initFocuserProperties (const char *deviceName, const char *groupName)
 Initilize focuser properties. It is recommended to call this function within initProperties() of your primary device. More...
 
bool processFocuserNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process focus number properties. More...
 
bool processFocuserSwitch (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...
 
virtual IPState MoveFocuser (FocusDirection dir, int speed, uint16_t duration)
 MoveFocuser the focuser in a particular direction with a specific speed for a finite duration. More...
 
virtual IPState MoveAbsFocuser (uint32_t targetTicks)
 MoveFocuser the focuser to an absolute position. More...
 
virtual IPState MoveRelFocuser (FocusDirection dir, uint32_t ticks)
 MoveFocuser the focuser to an relative position. More...
 
virtual bool AbortFocuser ()
 AbortFocuser all focus motion. More...
 

Protected Attributes

INumber PresetN [3]
 
INumberVectorProperty PresetNP
 
ISwitch PresetGotoS [3]
 
ISwitchVectorProperty PresetGotoSP
 
INDI::Controllercontroller
 
Connection::SerialserialConnection = NULL
 
Connection::TCPtcpConnection = NULL
 
int PortFD = -1
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t updatePeriodMS = 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
 
char focuserName [MAXINDIDEVICE]
 
double lastTimerValue
 

Detailed Description

Class to provide general functionality of a focuser device.

Both relative and absolute focuser supported. Furthermore, if no position feedback is available from the focuser, an open-loop control is possible using timers, speed presets, and direction of motion. Developers need to subclass INDI::Focuser to implement any driver for focusers within INDI.

Author
Jasem Mutlaq
Gerry Rozema

Definition at line 40 of file indifocuser.h.

Member Enumeration Documentation

anonymous enum
Enumerator
CONNECTION_NONE 
CONNECTION_SERIAL 

Do not use any connection plugin

CONNECTION_TCP 

For regular serial and bluetooth connections

Definition at line 49 of file indifocuser.h.

Constructor & Destructor Documentation

INDI::Focuser::Focuser ( )

Definition at line 27 of file indifocuser.cpp.

INDI::Focuser::~Focuser ( )
virtual

Definition at line 34 of file indifocuser.cpp.

Member Function Documentation

void INDI::Focuser::buttonHelper ( const char *  button_n,
ISState  state,
void *  context 
)
static

Definition at line 246 of file indifocuser.cpp.

uint8_t INDI::Focuser::getFocuserConnection ( ) const
Returns
Get current Focuser connection mode

Definition at line 365 of file indifocuser.cpp.

bool INDI::Focuser::Handshake ( )
protectedvirtual

perform handshake with device to check communication

Reimplemented in USBFocusV3, Gemini, FocusLynxBase, TCFS, Microtouch, SteelDrive, NFocus, NightCrawler, NSTEP, MoonLite, SmartFocus, and RoboFocus.

Definition at line 230 of file indifocuser.cpp.

bool INDI::Focuser::initProperties ( )
virtual

Initilize properties initial state and value. The child class must implement this function.

Returns
True if initilization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in USBFocusV3, Gemini, TCFS, FocusLynxBase, Microtouch, SteelDrive, HitecAstroDCFocuser, NFocus, PerfectStar, NSTEP, FocusLynxF1, NightCrawler, MoonLite, RoboFocus, FocusSim, and SmartFocus.

Definition at line 38 of file indifocuser.cpp.

void INDI::Focuser::ISGetProperties ( const char *  dev)
virtual

define the driver's properties to the client. Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device.

Parameters
devname of the device
Note
This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::DefaultDevice.

Reimplemented in FocusLynxF2, TCFS, FocusLynxBase, FocusLynxF1, and FocusSim.

Definition at line 84 of file indifocuser.cpp.

bool INDI::Focuser::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
virtual

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::DefaultDevice.

Reimplemented in USBFocusV3, FocusLynxBase, Gemini, SteelDrive, Microtouch, NSTEP, NFocus, FocusSim, NightCrawler, MoonLite, RoboFocus, HitecAstroDCFocuser, PerfectStar, and SmartFocus.

Definition at line 142 of file indifocuser.cpp.

bool INDI::Focuser::ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
virtual

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::DefaultDevice.

Reimplemented in USBFocusV3, FocusLynxBase, TCFS, Gemini, SteelDrive, Microtouch, NSTEP, FocusSim, NightCrawler, MoonLite, RoboFocus, and HitecAstroDCFocuser.

Definition at line 165 of file indifocuser.cpp.

bool INDI::Focuser::ISNewText ( const char *  dev,
const char *  name,
char *  texts[],
char *  names[],
int  n 
)
virtual

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::DefaultDevice.

Reimplemented in FocusLynxBase, and Gemini.

Definition at line 216 of file indifocuser.cpp.

bool INDI::Focuser::ISSnoopDevice ( XMLEle root)
virtual

Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver.

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::DefaultDevice.

Definition at line 223 of file indifocuser.cpp.

void INDI::Focuser::processButton ( const char *  button_n,
ISState  state 
)
protected

Definition at line 251 of file indifocuser.cpp.

bool INDI::Focuser::saveConfigItems ( FILE *  fp)
protectedvirtual

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::DefaultDevice.

Reimplemented in Gemini, FocusLynxBase, SteelDrive, NightCrawler, NSTEP, NFocus, SmartFocus, RoboFocus, HitecAstroDCFocuser, and PerfectStar.

Definition at line 235 of file indifocuser.cpp.

void INDI::Focuser::setFocuserConnection ( const uint8_t &  value)

setFocuserConnection Set Focuser connection mode. Child class should call this in the constructor before INDI::Focuser registers any connection interfaces

Parameters
valueORed combination of FocuserConnection values.

Definition at line 370 of file indifocuser.cpp.

bool INDI::Focuser::updateProperties ( )
virtual

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::DefaultDevice.

Reimplemented in USBFocusV3, Gemini, FocusLynxBase, TCFS, Microtouch, SteelDrive, HitecAstroDCFocuser, NFocus, PerfectStar, NSTEP, NightCrawler, MoonLite, FocusLynxF1, RoboFocus, FocusSim, and SmartFocus.

Definition at line 93 of file indifocuser.cpp.

Member Data Documentation

INDI::Controller* INDI::Focuser::controller
protected

Definition at line 96 of file indifocuser.h.

enum { ... } INDI::Focuser::FocuserConnection
int INDI::Focuser::PortFD = -1
protected

Definition at line 101 of file indifocuser.h.

ISwitch INDI::Focuser::PresetGotoS[3]
protected

Definition at line 91 of file indifocuser.h.

ISwitchVectorProperty INDI::Focuser::PresetGotoSP
protected

Definition at line 92 of file indifocuser.h.

INumber INDI::Focuser::PresetN[3]
protected

Definition at line 89 of file indifocuser.h.

INumberVectorProperty INDI::Focuser::PresetNP
protected

Definition at line 90 of file indifocuser.h.

Connection::Serial* INDI::Focuser::serialConnection = NULL
protected

Definition at line 98 of file indifocuser.h.

Connection::TCP* INDI::Focuser::tcpConnection = NULL
protected

Definition at line 99 of file indifocuser.h.


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