Instrument Neutral Distributed Interface INDI  1.9.2
Public Types | Public Member Functions | Protected Member Functions | List of all members
SmartFocus Class Reference

#include <smartfocus.h>

Inheritance diagram for SmartFocus:
INDI::Focuser INDI::DefaultDevice INDI::FocuserInterface INDI::BaseDevice

Public Types

typedef unsigned short Position
 
- Public Types inherited from INDI::Focuser
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 }
 
enum  { INDI_ENABLED, INDI_DISABLED }
 
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), CORRELATOR_INTERFACE = (1 << 14),
  AUX_INTERFACE = (1 << 15), SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE | DETECTOR_INTERFACE | CORRELATOR_INTERFACE
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...
 
typedef INDI::Properties Properties
 
- Public Types inherited from INDI::FocuserInterface
enum  FocusDirection { FOCUS_INWARD, FOCUS_OUTWARD }
 
enum  {
  FOCUSER_CAN_ABS_MOVE = 1 << 0, FOCUSER_CAN_REL_MOVE = 1 << 1, FOCUSER_CAN_ABORT = 1 << 2, FOCUSER_CAN_REVERSE = 1 << 3,
  FOCUSER_CAN_SYNC = 1 << 4, FOCUSER_HAS_VARIABLE_SPEED = 1 << 5, FOCUSER_HAS_BACKLASH = 1 << 6
}
 

Public Member Functions

 SmartFocus ()
 
const char * getDefaultName () override
 
bool initProperties () override
 Initilize properties initial state and value. The child class must implement this function. More...
 
bool updateProperties () override
 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 Handshake () override
 perform handshake with device to check communication More...
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
virtual bool AbortFocuser () override
 AbortFocuser all focus motion. 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 void TimerHit () override
 Callback function to be called once SetTimer duration elapses. More...
 
- Public Member Functions inherited from INDI::Focuser
 Focuser ()
 
virtual ~Focuser ()
 
virtual void ISGetProperties (const char *dev) override
 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 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...
 
virtual bool ISSnoopDevice (XMLEle *root) override
 Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More...
 
void setSupportedConnections (const uint8_t &value)
 setConnection Set Focuser connection mode. Child class should call this in the constructor before Focuser registers any connection interfaces More...
 
uint8_t getSupportedConnections () const
 
- Public Member Functions inherited from INDI::DefaultDevice
 DefaultDevice ()
 
virtual ~DefaultDevice () override=default
 
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) __attribute__((deprecated))
 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 defineProperty (INumberVectorProperty *property)
 
void defineText (ITextVectorProperty *tvp) __attribute__((deprecated))
 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 defineProperty (ITextVectorProperty *property)
 
void defineSwitch (ISwitchVectorProperty *svp) __attribute__((deprecated))
 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 defineProperty (ISwitchVectorProperty *property)
 
void defineLight (ILightVectorProperty *lvp) __attribute__((deprecated))
 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 defineProperty (ILightVectorProperty *property)
 
void defineBLOB (IBLOBVectorProperty *bvp) __attribute__((deprecated))
 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...
 
void defineProperty (IBLOBVectorProperty *property)
 
void defineProperty (INDI::Property &property)
 
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 (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 () const
 
uint16_t getMinorVersion () const
 
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 () override
 
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 ()
 
INDI::PropertyView< INumber > * getNumber (const char *name) const
 
INDI::PropertyView< IText > * getText (const char *name) const
 
INDI::PropertyView< ISwitch > * getSwitch (const char *name) const
 
INDI::PropertyView< ILight > * getLight (const char *name) const
 
INDI::PropertyView< IBLOB > * getBLOB (const char *name) const
 
IPState getPropertyState (const char *name) const
 
IPerm getPropertyPermission (const char *name) const
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
void registerProperty (ITextVectorProperty *property)
 
void registerProperty (INumberVectorProperty *property)
 
void registerProperty (ISwitchVectorProperty *property)
 
void registerProperty (ILightVectorProperty *property)
 
void registerProperty (IBLOBVectorProperty *property)
 
void registerProperty (INDI::PropertyView< IText > *property)
 
void registerProperty (INDI::PropertyView< INumber > *property)
 
void registerProperty (INDI::PropertyView< ISwitch > *property)
 
void registerProperty (INDI::PropertyView< ILight > *property)
 
void registerProperty (INDI::PropertyView< IBLOB > *property)
 
void registerProperty (INDI::Property &property)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
Property getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
Properties getProperties ()
 Return a list of all properties in the device. More...
 
const Properties getProperties () const
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
const std::string & messageQueue (size_t index) const
 
const std::string & lastMessage () const
 
bool isConnected () const
 
void setMediator (INDI::BaseMediator *mediator)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator () const
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName () const
 
bool isDeviceNameMatch (const char *otherName) const
 Check that the device name matches the argument. More...
 
bool isDeviceNameMatch (const std::string &otherName) const
 Check that the device name matches the argument. More...
 
const char * getDriverName () const
 
const char * getDriverExec () const
 
const char * getDriverVersion () const
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. 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...
 
- 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. All capabilities must be initialized. More...
 
bool CanAbsMove ()
 
bool CanRelMove ()
 
bool CanAbort ()
 
bool CanReverse ()
 
bool CanSync ()
 
bool HasVariableSpeed ()
 
bool HasBacklash ()
 

Protected Member Functions

virtual bool saveConfigItems (FILE *fp) override
 saveConfigItems Saves the Device Port and Focuser Presets in the configuration file More...
 
- Protected Member Functions inherited from INDI::Focuser
virtual bool SetFocuserMaxPosition (uint32_t ticks) override
 SetFocuserMaxPosition Update focuser maximum position. It only updates the PresetNP property limits. More...
 
virtual void SyncPresets (uint32_t ticks)
 syncPresets Updates the min/max/step range of the preset as per the maximum name of Absolute Focus Travel 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 purgeConfig ()
 purgeConfig Remove config file from disk. 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 () const
 
bool isSimulation () const
 
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 ()
 
void setActiveConnection (Connection::Interface *existingConnection)
 setActiveConnection Switch the active connection to the passed connection plugin More...
 
void setDefaultPollingPeriod (uint32_t msec)
 setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver. More...
 
void setPollingPeriodRange (uint32_t minimum, uint32_t maximum)
 setPollingPeriodRange Set the range permitted by the polling range in milliseconds More...
 
uint32_t getPollingPeriod () const
 getPollingPeriod Return the polling period. More...
 
void setCurrentPollingPeriod (uint32_t msec)
 setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver. More...
 
uint32_t getCurrentPollingPeriod () const
 getCurrentPollingPeriod Return the current polling period. More...
 
uint32_t & refCurrentPollingPeriod () __attribute__((deprecated))
 
uint32_t refCurrentPollingPeriod () const __attribute__((deprecated))
 
bool isConfigLoading () const
 isConfigLoading Check if driver configuration is currently in the process of getting loaded. More...
 
void syncDriverInfo ()
 syncDriverInfo sends the current driver information to the client. More...
 
 DefaultDevice (DefaultDevicePrivate &dd)
 
- Protected Member Functions inherited from INDI::BaseDevice
 BaseDevice (BaseDevicePrivate &dd)
 
- Protected Member Functions inherited from INDI::FocuserInterface
 FocuserInterface (DefaultDevice *defaultDevice)
 
virtual ~FocuserInterface ()=default
 
void initProperties (const char *groupName)
 Initilize focuser properties. It is recommended to call this function within initProperties() of your primary device. 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...
 
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 bool ReverseFocuser (bool enabled)
 ReverseFocuser Reverse focuser motion direction. More...
 
virtual bool SyncFocuser (uint32_t ticks)
 SyncFocuser Set current position to ticks without moving the focuser. More...
 
virtual bool SetFocuserBacklash (int32_t steps)
 SetFocuserBacklash Set the focuser backlash compensation value. More...
 
virtual bool SetFocuserBacklashEnabled (bool enabled)
 SetFocuserBacklashEnabled Enables or disables the focuser backlash compensation. More...
 
bool saveConfigItems (FILE *fp)
 saveConfigItems save focuser properties defined in the interface in config file More...
 

Additional Inherited Members

- Static Public Member Functions inherited from INDI::Focuser
static void buttonHelper (const char *button_n, ISState state, void *context)
 
- Public Attributes inherited from INDI::Focuser
enum INDI::Focuser:: { ... }  FocuserConnection
 
- Public Attributes inherited from INDI::FocuserInterface
enum INDI::FocuserInterface:: { ... }  FocuserCapability
 
- 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::BaseDevice
std::shared_ptr< BaseDevicePrivated_ptr
 
- 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]
 
INumberVectorProperty FocusMaxPosNP
 
INumber FocusMaxPosN [1]
 
INumberVectorProperty FocusSyncNP
 
INumber FocusSyncN [1]
 
ISwitchVectorProperty FocusAbortSP
 
ISwitch FocusAbortS [1]
 
ISwitchVectorProperty FocusReverseSP
 
ISwitch FocusReverseS [2]
 
ISwitchVectorProperty FocusBacklashSP
 
ISwitch FocusBacklashS [2]
 
INumberVectorProperty FocusBacklashNP
 
INumber FocusBacklashN [1]
 
uint32_t capability
 
double lastTimerValue = { 0 }
 
DefaultDevicem_defaultDevice { nullptr }
 

Detailed Description

Definition at line 23 of file smartfocus.h.

Member Typedef Documentation

◆ Position

typedef unsigned short SmartFocus::Position

Definition at line 59 of file smartfocus.h.

Constructor & Destructor Documentation

◆ SmartFocus()

SmartFocus::SmartFocus ( )

Definition at line 52 of file smartfocus.cpp.

Member Function Documentation

◆ AbortFocuser()

bool SmartFocus::AbortFocuser ( )
overridevirtual

AbortFocuser all focus motion.

Returns
True if abort is successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Definition at line 152 of file smartfocus.cpp.

◆ getDefaultName()

const char * SmartFocus::getDefaultName ( )
overridevirtual
Returns
Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 128 of file smartfocus.cpp.

◆ Handshake()

bool SmartFocus::Handshake ( )
overridevirtual

perform handshake with device to check communication

Reimplemented from INDI::Focuser.

Definition at line 113 of file smartfocus.cpp.

◆ initProperties()

bool SmartFocus::initProperties ( )
overridevirtual

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.

Definition at line 57 of file smartfocus.cpp.

◆ ISNewNumber()

bool SmartFocus::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.

Definition at line 133 of file smartfocus.cpp.

◆ MoveAbsFocuser()

IPState SmartFocus::MoveAbsFocuser ( uint32_t  targetTicks)
overridevirtual

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.

Definition at line 164 of file smartfocus.cpp.

◆ MoveRelFocuser()

IPState SmartFocus::MoveRelFocuser ( FocusDirection  dir,
uint32_t  ticks 
)
overridevirtual

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.

Definition at line 214 of file smartfocus.cpp.

◆ saveConfigItems()

bool SmartFocus::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.

Definition at line 273 of file smartfocus.cpp.

◆ TimerHit()

void SmartFocus::TimerHit ( )
overridevirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

Definition at line 245 of file smartfocus.cpp.

◆ updateProperties()

bool SmartFocus::updateProperties ( )
overridevirtual

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.

Definition at line 94 of file smartfocus.cpp.


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