#include <indifocuser.h>

Inheritance diagram for INDI::Focuser:

Collaboration diagram for INDI::Focuser:

Public Types
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 Member Functions
	Focuser ()

virtual	~Focuser ()

virtual bool	initProperties ()
	Initilize properties initial state and value. More...

virtual void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...

virtual bool	updateProperties ()
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. 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. More...

void	setSupportedConnections (const uint8_t &value)
	setConnection Set Focuser connection mode. More...

uint8_t	getSupportedConnections () const

	Focuser ()

virtual	~Focuser ()

virtual bool	initProperties ()
	Initilize properties initial state and value. More...

virtual void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...

virtual bool	updateProperties ()
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. 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. 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 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. 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 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. More...

Public Member Functions inherited from INDI::BaseDevice
	BaseDevice ()

virtual	~BaseDevice ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (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::Property *	getProperty (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::BaseMediator *	getMediator ()

const char *	getDriverName ()

const char *	getDriverExec ()

const char *	getDriverVersion ()

	BaseDevice ()

virtual	~BaseDevice ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (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::Property *	getProperty (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::BaseMediator *	getMediator ()

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 ()

Static Public Member Functions
static void	buttonHelper (const char button_n, ISState state, void context)

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

Public Attributes
enum INDI::Focuser:: { ... }	FocuserConnection

enum INDI::Focuser:: { ... }	FocuserConnection

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

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)

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. 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::Interface *	getActiveConnection ()

void	setDefaultPollingPeriod (uint32_t period)

uint32_t	getPollingPeriod ()

virtual const char *	getDefaultName ()=0

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::Interface *	getActiveConnection ()

void	setDefaultPollingPeriod (uint32_t period)

uint32_t	getPollingPeriod ()

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

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

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

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

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

Controller *	controller

Connection::Serial *	serialConnection = nullptr

Connection::TCP *	tcpConnection = 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 }

DefaultDevice *	m_defaultDevice { nullptr }

Private Member Functions
bool	callHandshake ()

bool	callHandshake ()

Private Attributes
uint8_t	focuserConnection = CONNECTION_SERIAL \| CONNECTION_TCP

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
CONNECTION_NONE
CONNECTION_SERIAL	Do not use any connection plugin.
CONNECTION_TCP	For regular serial and bluetooth connections.

◆ anonymous enum

anonymous enum

Enumerator
CONNECTION_NONE
CONNECTION_SERIAL	Do not use any connection plugin.
CONNECTION_TCP	For regular serial and bluetooth connections.

Constructor & Destructor Documentation

◆ Focuser() [1/2]

Focuser::Focuser ( )

◆ ~Focuser() [1/2]

Focuser::~Focuser ( )

virtual

◆ Focuser() [2/2]

INDI::Focuser::Focuser ( )

◆ ~Focuser() [2/2]

virtual INDI::Focuser::~Focuser ( )

virtual

Member Function Documentation

◆ buttonHelper() [1/2]

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

static

◆ buttonHelper() [2/2]

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

static

◆ callHandshake() [1/2]

bool Focuser::callHandshake ( )

private

◆ callHandshake() [2/2]

bool INDI::Focuser::callHandshake ( )

private

◆ getSupportedConnections() [1/2]

uint8_t INDI::Focuser::getSupportedConnections ( ) const

inline

Returns: Get current Focuser connection mode

◆ getSupportedConnections() [2/2]

uint8_t INDI::Focuser::getSupportedConnections ( ) const

inline

Returns: Get current Focuser connection mode

◆ Handshake() [1/2]

virtual bool INDI::Focuser::Handshake ( )

protectedvirtual

perform handshake with device to check communication

Reimplemented in USBFocusV3, FocusLynxBase, Gemini, TCFS, Microtouch, SteelDrive, Lakeside, Integra, SestoSenso, NFocus, NightCrawler, NSTEP, ArmPlat, MoonLite, SmartFocus, RoboFocus, and DMFC.

◆ Handshake() [2/2]

bool Focuser::Handshake ( )

protectedvirtual

perform handshake with device to check communication

Reimplemented in USBFocusV3, FocusLynxBase, Gemini, TCFS, Microtouch, SteelDrive, Lakeside, Integra, SestoSenso, NFocus, NightCrawler, NSTEP, ArmPlat, MoonLite, SmartFocus, RoboFocus, and DMFC.

◆ initProperties() [1/2]

bool 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, FocusLynxBase, Gemini, FocusLynxF2, TCFS, Microtouch, SteelDrive, Integra, FocusSim, HitecAstroDCFocuser, FLIPDF, NFocus, PerfectStar, FocusLynxF1, Lakeside, NSTEP, NightCrawler, FocusMaster, ArmPlat, MoonLite, RoboFocus, SestoSenso, DMFC, and SmartFocus.

◆ initProperties() [2/2]

virtual 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, FocusLynxBase, Gemini, FocusLynxF2, TCFS, Microtouch, SteelDrive, Integra, FocusSim, HitecAstroDCFocuser, FLIPDF, NFocus, PerfectStar, FocusLynxF1, Lakeside, NSTEP, NightCrawler, FocusMaster, ArmPlat, MoonLite, RoboFocus, SestoSenso, DMFC, and SmartFocus.

◆ ISGetProperties() [1/2]

void 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

dev	name 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 FocusLynxBase, FocusSim, and FLIPDF.

◆ ISGetProperties() [2/2]

virtual 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

dev	name 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 FocusLynxBase, FocusSim, and FLIPDF.

◆ ISNewNumber() [1/2]

bool 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, FocusSim, Integra, NSTEP, NFocus, Lakeside, NightCrawler, ArmPlat, MoonLite, SestoSenso, RoboFocus, DMFC, HitecAstroDCFocuser, PerfectStar, SmartFocus, and FocusMaster.

◆ ISNewNumber() [2/2]

virtual 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, FocusSim, Integra, NSTEP, NFocus, Lakeside, NightCrawler, ArmPlat, MoonLite, SestoSenso, RoboFocus, DMFC, HitecAstroDCFocuser, PerfectStar, SmartFocus, and FocusMaster.

◆ ISNewSwitch() [1/2]

virtual 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, FocusSim, Integra, FLIPDF, Lakeside, NSTEP, NightCrawler, ArmPlat, MoonLite, RoboFocus, DMFC, HitecAstroDCFocuser, and FocusMaster.

◆ ISNewSwitch() [2/2]

bool 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, FocusSim, Integra, FLIPDF, Lakeside, NSTEP, NightCrawler, ArmPlat, MoonLite, RoboFocus, DMFC, HitecAstroDCFocuser, and FocusMaster.

◆ ISNewText() [1/2]

virtual 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.

◆ ISNewText() [2/2]

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

◆ ISSnoopDevice() [1/2]

virtual 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.

◆ ISSnoopDevice() [2/2]

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

◆ processButton() [1/2]

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

protected

◆ processButton() [2/2]

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

protected

◆ saveConfigItems() [1/2]

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

protectedvirtual

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

Parameters

fp	pointer to configuration file

Returns: true if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

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

◆ saveConfigItems() [2/2]

bool Focuser::saveConfigItems ( FILE * fp )

protectedvirtual

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

Parameters

fp	pointer to configuration file

Returns: true if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

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

◆ setSupportedConnections() [1/2]

void Focuser::setSupportedConnections ( const uint8_t & value )

setConnection Set Focuser connection mode.

Child class should call this in the constructor before Focuser registers any connection interfaces

Parameters

value ORed combination of FocuserConnection values.

◆ setSupportedConnections() [2/2]

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

setConnection Set Focuser connection mode.

Child class should call this in the constructor before Focuser registers any connection interfaces

Parameters

value ORed combination of FocuserConnection values.

◆ updateProperties() [1/2]

bool 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, FocusLynxBase, Gemini, TCFS, Microtouch, SteelDrive, Integra, FocusSim, FLIPDF, HitecAstroDCFocuser, NFocus, PerfectStar, Lakeside, NSTEP, NightCrawler, FocusMaster, ArmPlat, FocusLynxF1, MoonLite, RoboFocus, SestoSenso, DMFC, and SmartFocus.

◆ updateProperties() [2/2]

virtual 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, FocusLynxBase, Gemini, TCFS, Microtouch, SteelDrive, Integra, FocusSim, FLIPDF, HitecAstroDCFocuser, NFocus, PerfectStar, Lakeside, NSTEP, NightCrawler, FocusMaster, ArmPlat, FocusLynxF1, MoonLite, RoboFocus, SestoSenso, DMFC, and SmartFocus.

Member Data Documentation

◆ controller

Controller * Focuser::controller

protected

◆ FocuserConnection [1/2]

enum { ... } INDI::Focuser::FocuserConnection

◆ FocuserConnection [2/2]

enum { ... } INDI::Focuser::FocuserConnection

◆ focuserConnection

uint8_t Focuser::focuserConnection = CONNECTION_SERIAL | CONNECTION_TCP

private

◆ PortFD

int Focuser::PortFD = -1

protected

◆ PresetGotoS

ISwitch Focuser::PresetGotoS

protected

◆ PresetGotoSP

ISwitchVectorProperty Focuser::PresetGotoSP

protected

◆ PresetN

INumber Focuser::PresetN

protected

◆ PresetNP

INumberVectorProperty Focuser::PresetNP

protected

◆ serialConnection

Connection::Serial * Focuser::serialConnection = nullptr

protected

◆ tcpConnection

Connection::TCP * Focuser::tcpConnection = nullptr

protected

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

/home/nirva/insroot/include/libindi/indifocuser.h
ln/3rdparty/src/indilib/indi-1.7.4/libindi/libs/indibase/indifocuser.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ Focuser() [1/2]

◆ ~Focuser() [1/2]

◆ Focuser() [2/2]

◆ ~Focuser() [2/2]

Member Function Documentation

◆ buttonHelper() [1/2]

◆ buttonHelper() [2/2]

◆ callHandshake() [1/2]

◆ callHandshake() [2/2]

◆ getSupportedConnections() [1/2]

◆ getSupportedConnections() [2/2]

◆ Handshake() [1/2]

◆ Handshake() [2/2]

◆ initProperties() [1/2]

◆ initProperties() [2/2]

◆ ISGetProperties() [1/2]

◆ ISGetProperties() [2/2]

◆ ISNewNumber() [1/2]

◆ ISNewNumber() [2/2]

◆ ISNewSwitch() [1/2]

◆ ISNewSwitch() [2/2]

◆ ISNewText() [1/2]

◆ ISNewText() [2/2]

◆ ISSnoopDevice() [1/2]

◆ ISSnoopDevice() [2/2]

◆ processButton() [1/2]

◆ processButton() [2/2]

◆ saveConfigItems() [1/2]

◆ saveConfigItems() [2/2]

◆ setSupportedConnections() [1/2]

◆ setSupportedConnections() [2/2]

◆ updateProperties() [1/2]

◆ updateProperties() [2/2]

Member Data Documentation

◆ controller

◆ FocuserConnection [1/2]

◆ FocuserConnection [2/2]

◆ focuserConnection

◆ PortFD

◆ PresetGotoS

◆ PresetGotoSP

◆ PresetN

◆ PresetNP

◆ serialConnection

◆ tcpConnection