Instrument Neutral Distributed Interface INDI  2.0.2
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
TeenAstroFocuser Class Reference

#include <teenastro.h>

Inheritance diagram for TeenAstroFocuser:
INDI::Focuser INDI::DefaultDevice INDI::FocuserInterface INDI::ParentDevice INDI::BaseDevice

Public Member Functions

 TeenAstroFocuser ()
 
 ~TeenAstroFocuser ()
 
const char * getDefaultName ()
 
virtual bool Handshake ()
 perform handshake with device to check communication 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...
 
- 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 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)
 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)
 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)
 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)
 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)
 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...
 
bool deleteProperty (INDI::Property &property)
 deleteProperty 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...
 
uint16_t getDriverInterface () const
 
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...
 
void watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback)
 Add a device to the watch list. More...
 
- Public Member Functions inherited from INDI::ParentDevice
 ParentDevice (Type type)
 
 ~ParentDevice ()
 
 ParentDevice (ParentDevice &&other)=default
 
ParentDeviceoperator= (ParentDevice &&other)=default
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
void registerProperty (const INDI::Property &property)
 Register the property to be able to observe and update. More...
 
void registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW)
 Call the callback function if property is available. 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
 
INDI::PropertyNumber getNumber (const char *name) const
 
INDI::PropertyText getText (const char *name) const
 
INDI::PropertySwitch getSwitch (const char *name) const
 
INDI::PropertyLight getLight (const char *name) const
 
INDI::PropertyBlob getBLOB (const char *name) const
 
IPState getPropertyState (const char *name) const
 
IPerm getPropertyPermission (const char *name) const
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
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 isValid () const
 
bool isConnected () const
 
void attach ()
 indicates that the device is ready More...
 
void detach ()
 indicates that the device is being removed More...
 
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
 
uint16_t getDriverInterface () const
 getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
int buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (const INDI::LilXmlElement &root, char *errmsg)
 handle SetXXX commands from client More...
 
 operator BaseDevice * ()
 
BaseDeviceoperator-> ()
 
bool operator!= (std::nullptr_t) const
 
bool operator== (std::nullptr_t) const
 
 operator bool () const
 
 operator bool ()
 
- 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 Types

enum  {
  TAF_MICROS_4 , TAF_MICROS_8 , TAF_MICROS_16 , TAF_MICROS_32 ,
  TAF_MICROS_64 , TAF_MICROS_128 , TAF_MICROS_N
}
 

Protected Member Functions

bool ISNewNumberHelper (INumberVectorProperty *NP, double values[], char *names[], int n, bool res)
 
virtual bool initProperties ()
 Initilize properties initial state and value. The child class must implement this function. More...
 
void initPositionPropertiesRanges (uint32_t maxPos)
 
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...
 
void defineMainControlProperties ()
 
void defineOtherProperties ()
 
void deleteMainControlProperties ()
 
void deleteOtherProperties ()
 
virtual IPState MoveAbsFocuser (uint32_t ticks)
 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...
 
virtual void TimerHit ()
 Callback function to be called once SetTimer duration elapses. More...
 
virtual bool SyncFocuser (uint32_t value)
 SyncFocuser Set current position to ticks without moving the focuser. More...
 
bool SetFocuserMaxPosition (uint32_t value)
 SetFocuserMaxPosition Update focuser maximum position. It only updates the PresetNP property limits. More...
 
bool ReverseFocuser (bool enable)
 ReverseFocuser Reverse focuser motion direction. More...
 
bool saveConfigItems (FILE *fp)
 saveConfigItems Saves the Device Port and Focuser Presets in the configuration file More...
 
bool send (const char *const msg)
 
bool sendAndReceive (const char *const msg, char *resp, int bufsize)
 
bool sendAndReceiveBool (const char *const msg)
 
bool sendAndExpectTimeout (const char *const msg, char *resp, int bufsize)
 
bool updateDeviceVersion ()
 
bool updateState ()
 
bool isMoving ()
 
bool updateMotionConfig ()
 
bool setConfigItem (char item, uint32_t deviceValue)
 
bool setParkPos (uint32_t value)
 
bool SetFocuserSpeed (int value)
 SetFocuserSpeed Set Focuser speed. More...
 
bool setManualSpeed (uint32_t value)
 
bool setGoToAcc (uint32_t value)
 
bool setManualAcc (uint32_t value)
 
bool setManualDec (uint32_t value)
 
bool updateMotorConfig ()
 
bool setMotorMicrosteps (uint32_t value)
 
bool setMotorResolution (uint32_t value)
 
bool setMotorCurrent (uint32_t value)
 
bool setMotorStepsPerRevolution (uint32_t value)
 
bool goTo (uint32_t position)
 
bool goToPark ()
 
bool stop ()
 
bool rebootDevice ()
 
bool eraseDeviceEEPROM ()
 
- Protected Member Functions inherited from INDI::Focuser
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...
 
bool loadConfig (INDI::Property &property)
 Load property config from the configuration file. If the property configuration is successfully parsed, the corresponding ISNewXXX is called with the values parsed from the config file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
bool saveConfig (INDI::Property &property)
 Save a property in the 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...
 
bool isInitializationComplete () const
 isInitializationComplete Check if driver initialization is complete. More...
 
void syncDriverInfo ()
 syncDriverInfo sends the current driver information to the client. More...
 
 DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd)
 
- Protected Member Functions inherited from INDI::ParentDevice
 ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd)
 
- Protected Member Functions inherited from INDI::BaseDevice
 BaseDevice (BaseDevicePrivate &dd)
 
 BaseDevice (const std::shared_ptr< 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 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 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...
 

Protected Attributes

INumber CfgParkPosN [1]
 
INumberVectorProperty CfgParkPosNP
 
ISwitch GoToParkS [1]
 
ISwitchVectorProperty GoToParkSP
 
INumber CurSpeedN [1]
 
INumberVectorProperty CurSpeedNP
 
INumber TempN [1]
 
INumberVectorProperty TempNP
 
IText DeviceVersionT [1]
 
ITextVectorProperty DeviceVersionTP
 
INumber CfgManualSpeedN [1]
 
INumberVectorProperty CfgManualSpeedNP
 
INumber CfgGoToAccN [1]
 
INumberVectorProperty CfgGoToAccNP
 
INumber CfgManualAccN [1]
 
INumberVectorProperty CfgManualAccNP
 
INumber CfgManualDecN [1]
 
INumberVectorProperty CfgManualDecNP
 
ISwitch CfgMotorMicrostepsS [TAF_MICROS_N] {}
 
ISwitchVectorProperty CfgMotorMicrostepsSP
 
INumber CfgMotorResolutionN [1]
 
INumberVectorProperty CfgMotorResolutionNP
 
INumber CfgMotorCurrentN [1]
 
INumberVectorProperty CfgMotorCurrentNP
 
INumber CfgMotorStepsPerRevolutionN [1]
 
INumberVectorProperty CfgMotorStepsPerRevolutionNP
 
ISwitch RebootDeviceS [1]
 
ISwitchVectorProperty RebootDeviceSP
 
ISwitch EraseEEPROMS [1]
 
ISwitchVectorProperty EraseEEPROMSP
 
- 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 }
 

Additional Inherited Members

- Public Types inherited from INDI::Focuser
enum  { CONNECTION_NONE = 1 << 0 , CONNECTION_SERIAL = 1 << 1 , CONNECTION_TCP = 1 << 2 }
 
- Public Types inherited from INDI::ParentDevice
enum  Type { Valid , Invalid }
 
- 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  WATCH { WATCH_NEW = 0 , WATCH_UPDATE , WATCH_NEW_OR_UPDATE }
 
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
}
 
- Static Public Member Functions inherited from INDI::Focuser
static void buttonHelper (const char *button_n, ISState state, void *context)
 
- Static Public Member Functions inherited from INDI::BaseDevice
static std::string getSharedFilePath (std::string fileName)
 
- Public Attributes inherited from INDI::Focuser
enum INDI::Focuser:: { ... }  FocuserConnection
 
- Public Attributes inherited from INDI::FocuserInterface
enum INDI::FocuserInterface:: { ... }  FocuserCapability
 

Detailed Description

Definition at line 26 of file teenastro.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
TAF_MICROS_4 
TAF_MICROS_8 
TAF_MICROS_16 
TAF_MICROS_32 
TAF_MICROS_64 
TAF_MICROS_128 
TAF_MICROS_N 

Definition at line 182 of file teenastro.h.

Constructor & Destructor Documentation

◆ TeenAstroFocuser()

TeenAstroFocuser::TeenAstroFocuser ( )

Definition at line 67 of file teenastro.cpp.

◆ ~TeenAstroFocuser()

TeenAstroFocuser::~TeenAstroFocuser ( )

Definition at line 73 of file teenastro.cpp.

Member Function Documentation

◆ AbortFocuser()

bool TeenAstroFocuser::AbortFocuser ( )
protectedvirtual

AbortFocuser all focus motion.

Returns
True if abort is successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Definition at line 502 of file teenastro.cpp.

◆ defineMainControlProperties()

void TeenAstroFocuser::defineMainControlProperties ( )
protected

Definition at line 258 of file teenastro.cpp.

◆ defineOtherProperties()

void TeenAstroFocuser::defineOtherProperties ( )
protected

Definition at line 285 of file teenastro.cpp.

◆ deleteMainControlProperties()

void TeenAstroFocuser::deleteMainControlProperties ( )
protected

Definition at line 277 of file teenastro.cpp.

◆ deleteOtherProperties()

void TeenAstroFocuser::deleteOtherProperties ( )
protected

Definition at line 308 of file teenastro.cpp.

◆ eraseDeviceEEPROM()

bool TeenAstroFocuser::eraseDeviceEEPROM ( )
protected

Definition at line 849 of file teenastro.cpp.

◆ getDefaultName()

const char * TeenAstroFocuser::getDefaultName ( )
virtual
Returns
Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 77 of file teenastro.cpp.

◆ goTo()

bool TeenAstroFocuser::goTo ( uint32_t  position)
protected

Definition at line 824 of file teenastro.cpp.

◆ goToPark()

bool TeenAstroFocuser::goToPark ( )
protected

Definition at line 831 of file teenastro.cpp.

◆ Handshake()

bool TeenAstroFocuser::Handshake ( )
virtual

perform handshake with device to check communication

Reimplemented from INDI::Focuser.

Definition at line 82 of file teenastro.cpp.

◆ initPositionPropertiesRanges()

void TeenAstroFocuser::initPositionPropertiesRanges ( uint32_t  maxPos)
protected

Definition at line 225 of file teenastro.cpp.

◆ initProperties()

bool TeenAstroFocuser::initProperties ( )
protectedvirtual

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 115 of file teenastro.cpp.

◆ isMoving()

bool TeenAstroFocuser::isMoving ( )
protected

Definition at line 650 of file teenastro.cpp.

◆ ISNewNumber()

bool TeenAstroFocuser::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::Focuser.

Definition at line 389 of file teenastro.cpp.

◆ ISNewNumberHelper()

bool TeenAstroFocuser::ISNewNumberHelper ( INumberVectorProperty NP,
double  values[],
char *  names[],
int  n,
bool  res 
)
protected

Definition at line 380 of file teenastro.cpp.

◆ ISNewSwitch()

bool TeenAstroFocuser::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::Focuser.

Definition at line 326 of file teenastro.cpp.

◆ MoveAbsFocuser()

IPState TeenAstroFocuser::MoveAbsFocuser ( uint32_t  targetTicks)
protectedvirtual

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 461 of file teenastro.cpp.

◆ MoveRelFocuser()

IPState TeenAstroFocuser::MoveRelFocuser ( FocusDirection  dir,
uint32_t  ticks 
)
protectedvirtual

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 480 of file teenastro.cpp.

◆ rebootDevice()

bool TeenAstroFocuser::rebootDevice ( )
protected

Definition at line 841 of file teenastro.cpp.

◆ ReverseFocuser()

bool TeenAstroFocuser::ReverseFocuser ( bool  enabled)
protectedvirtual

ReverseFocuser Reverse focuser motion direction.

Parameters
enabledIf true, normal default focuser motion is reversed. If false, the direction is set to the default focuser motion.
Returns
True if successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Definition at line 787 of file teenastro.cpp.

◆ saveConfigItems()

bool TeenAstroFocuser::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::Focuser.

Definition at line 857 of file teenastro.cpp.

◆ send()

bool TeenAstroFocuser::send ( const char *const  msg)
protected

Definition at line 523 of file teenastro.cpp.

◆ sendAndExpectTimeout()

bool TeenAstroFocuser::sendAndExpectTimeout ( const char *const  msg,
char *  resp,
int  bufsize 
)
protected

Definition at line 581 of file teenastro.cpp.

◆ sendAndReceive()

bool TeenAstroFocuser::sendAndReceive ( const char *const  msg,
char *  resp,
int  bufsize 
)
protected

Definition at line 541 of file teenastro.cpp.

◆ sendAndReceiveBool()

bool TeenAstroFocuser::sendAndReceiveBool ( const char *const  msg)
protected

Definition at line 560 of file teenastro.cpp.

◆ setConfigItem()

bool TeenAstroFocuser::setConfigItem ( char  item,
uint32_t  deviceValue 
)
protected

Definition at line 700 of file teenastro.cpp.

◆ SetFocuserMaxPosition()

bool TeenAstroFocuser::SetFocuserMaxPosition ( uint32_t  ticks)
protectedvirtual

SetFocuserMaxPosition Update focuser maximum position. It only updates the PresetNP property limits.

Parameters
ticksmaximum ticks
Returns
True

Reimplemented from INDI::Focuser.

Definition at line 712 of file teenastro.cpp.

◆ SetFocuserSpeed()

bool TeenAstroFocuser::SetFocuserSpeed ( int  speed)
protectedvirtual

SetFocuserSpeed Set Focuser speed.

Parameters
speedfocuser speed
Returns
true if successful, false otherwise

Reimplemented from INDI::FocuserInterface.

Definition at line 722 of file teenastro.cpp.

◆ setGoToAcc()

bool TeenAstroFocuser::setGoToAcc ( uint32_t  value)
protected

Definition at line 727 of file teenastro.cpp.

◆ setManualAcc()

bool TeenAstroFocuser::setManualAcc ( uint32_t  value)
protected

Definition at line 732 of file teenastro.cpp.

◆ setManualDec()

bool TeenAstroFocuser::setManualDec ( uint32_t  value)
protected

Definition at line 737 of file teenastro.cpp.

◆ setManualSpeed()

bool TeenAstroFocuser::setManualSpeed ( uint32_t  value)
protected

Definition at line 717 of file teenastro.cpp.

◆ setMotorCurrent()

bool TeenAstroFocuser::setMotorCurrent ( uint32_t  value)
protected

Definition at line 806 of file teenastro.cpp.

◆ setMotorMicrosteps()

bool TeenAstroFocuser::setMotorMicrosteps ( uint32_t  value)
protected

Definition at line 792 of file teenastro.cpp.

◆ setMotorResolution()

bool TeenAstroFocuser::setMotorResolution ( uint32_t  value)
protected

Definition at line 801 of file teenastro.cpp.

◆ setMotorStepsPerRevolution()

bool TeenAstroFocuser::setMotorStepsPerRevolution ( uint32_t  value)
protected

Definition at line 811 of file teenastro.cpp.

◆ setParkPos()

bool TeenAstroFocuser::setParkPos ( uint32_t  value)
protected

Definition at line 707 of file teenastro.cpp.

◆ stop()

bool TeenAstroFocuser::stop ( )
protected

Definition at line 836 of file teenastro.cpp.

◆ SyncFocuser()

bool TeenAstroFocuser::SyncFocuser ( uint32_t  ticks)
protectedvirtual

SyncFocuser Set current position to ticks without moving the focuser.

Parameters
ticksDesired new sync position.
Returns
True if successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Definition at line 816 of file teenastro.cpp.

◆ TimerHit()

void TeenAstroFocuser::TimerHit ( )
protectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

Definition at line 493 of file teenastro.cpp.

◆ updateDeviceVersion()

bool TeenAstroFocuser::updateDeviceVersion ( )
protected

Definition at line 601 of file teenastro.cpp.

◆ updateMotionConfig()

bool TeenAstroFocuser::updateMotionConfig ( )
protected

Definition at line 658 of file teenastro.cpp.

◆ updateMotorConfig()

bool TeenAstroFocuser::updateMotorConfig ( )
protected

Definition at line 743 of file teenastro.cpp.

◆ updateProperties()

bool TeenAstroFocuser::updateProperties ( )
protectedvirtual

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 231 of file teenastro.cpp.

◆ updateState()

bool TeenAstroFocuser::updateState ( )
protected

Definition at line 614 of file teenastro.cpp.

Member Data Documentation

◆ CfgGoToAccN

INumber TeenAstroFocuser::CfgGoToAccN[1]
protected

Definition at line 164 of file teenastro.h.

◆ CfgGoToAccNP

INumberVectorProperty TeenAstroFocuser::CfgGoToAccNP
protected

Definition at line 165 of file teenastro.h.

◆ CfgManualAccN

INumber TeenAstroFocuser::CfgManualAccN[1]
protected

Definition at line 168 of file teenastro.h.

◆ CfgManualAccNP

INumberVectorProperty TeenAstroFocuser::CfgManualAccNP
protected

Definition at line 169 of file teenastro.h.

◆ CfgManualDecN

INumber TeenAstroFocuser::CfgManualDecN[1]
protected

Definition at line 172 of file teenastro.h.

◆ CfgManualDecNP

INumberVectorProperty TeenAstroFocuser::CfgManualDecNP
protected

Definition at line 173 of file teenastro.h.

◆ CfgManualSpeedN

INumber TeenAstroFocuser::CfgManualSpeedN[1]
protected

Definition at line 160 of file teenastro.h.

◆ CfgManualSpeedNP

INumberVectorProperty TeenAstroFocuser::CfgManualSpeedNP
protected

Definition at line 161 of file teenastro.h.

◆ CfgMotorCurrentN

INumber TeenAstroFocuser::CfgMotorCurrentN[1]
protected

Definition at line 194 of file teenastro.h.

◆ CfgMotorCurrentNP

INumberVectorProperty TeenAstroFocuser::CfgMotorCurrentNP
protected

Definition at line 195 of file teenastro.h.

◆ CfgMotorMicrostepsS

ISwitch TeenAstroFocuser::CfgMotorMicrostepsS[TAF_MICROS_N] {}
protected

Definition at line 186 of file teenastro.h.

◆ CfgMotorMicrostepsSP

ISwitchVectorProperty TeenAstroFocuser::CfgMotorMicrostepsSP
protected

Definition at line 187 of file teenastro.h.

◆ CfgMotorResolutionN

INumber TeenAstroFocuser::CfgMotorResolutionN[1]
protected

Definition at line 190 of file teenastro.h.

◆ CfgMotorResolutionNP

INumberVectorProperty TeenAstroFocuser::CfgMotorResolutionNP
protected

Definition at line 191 of file teenastro.h.

◆ CfgMotorStepsPerRevolutionN

INumber TeenAstroFocuser::CfgMotorStepsPerRevolutionN[1]
protected

Definition at line 198 of file teenastro.h.

◆ CfgMotorStepsPerRevolutionNP

INumberVectorProperty TeenAstroFocuser::CfgMotorStepsPerRevolutionNP
protected

Definition at line 199 of file teenastro.h.

◆ CfgParkPosN

INumber TeenAstroFocuser::CfgParkPosN[1]
protected

Definition at line 129 of file teenastro.h.

◆ CfgParkPosNP

INumberVectorProperty TeenAstroFocuser::CfgParkPosNP
protected

Definition at line 130 of file teenastro.h.

◆ CurSpeedN

INumber TeenAstroFocuser::CurSpeedN[1]
protected

Definition at line 140 of file teenastro.h.

◆ CurSpeedNP

INumberVectorProperty TeenAstroFocuser::CurSpeedNP
protected

Definition at line 141 of file teenastro.h.

◆ DeviceVersionT

IText TeenAstroFocuser::DeviceVersionT[1]
protected

Definition at line 154 of file teenastro.h.

◆ DeviceVersionTP

ITextVectorProperty TeenAstroFocuser::DeviceVersionTP
protected

Definition at line 155 of file teenastro.h.

◆ EraseEEPROMS

ISwitch TeenAstroFocuser::EraseEEPROMS[1]
protected

Definition at line 206 of file teenastro.h.

◆ EraseEEPROMSP

ISwitchVectorProperty TeenAstroFocuser::EraseEEPROMSP
protected

Definition at line 207 of file teenastro.h.

◆ GoToParkS

ISwitch TeenAstroFocuser::GoToParkS[1]
protected

Definition at line 133 of file teenastro.h.

◆ GoToParkSP

ISwitchVectorProperty TeenAstroFocuser::GoToParkSP
protected

Definition at line 134 of file teenastro.h.

◆ RebootDeviceS

ISwitch TeenAstroFocuser::RebootDeviceS[1]
protected

Definition at line 202 of file teenastro.h.

◆ RebootDeviceSP

ISwitchVectorProperty TeenAstroFocuser::RebootDeviceSP
protected

Definition at line 203 of file teenastro.h.

◆ TempN

INumber TeenAstroFocuser::TempN[1]
protected

Definition at line 144 of file teenastro.h.

◆ TempNP

INumberVectorProperty TeenAstroFocuser::TempNP
protected

Definition at line 145 of file teenastro.h.


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