#include <focuslynxbase.h>

Inheritance diagram for FocusLynxBase:

Collaboration diagram for FocusLynxBase:

Public Types
enum	{ FOCUS_A_COEFF, FOCUS_B_COEFF, FOCUS_C_COEFF, FOCUS_D_COEFF, FOCUS_E_COEFF, FOCUS_F_COEFF }

enum	LYNX_STATUS { STATUS_MOVING, STATUS_HOMING, STATUS_HOMED, STATUS_FFDETECT, STATUS_TMPPROBE, STATUS_REMOTEIO, STATUS_HNDCTRL, STATUS_REVERSE, STATUS_UNKNOWN }

enum	{ GOTO_CENTER, GOTO_HOME }

Public Types inherited from INDI::Focuser
enum	{ CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }

enum	{ CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }

Public Types inherited from INDI::BaseDevice
enum	INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4, INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }

enum	DRIVER_INTERFACE { GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15), GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15) }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...

enum	INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4, INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }

enum	DRIVER_INTERFACE { GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15), GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15) }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...

Public Types inherited from INDI::FocuserInterface
enum	FocusDirection { FOCUS_INWARD, FOCUS_OUTWARD, FOCUS_INWARD, FOCUS_OUTWARD }

enum	{ FOCUSER_CAN_ABS_MOVE = 1 << 0, FOCUSER_CAN_REL_MOVE = 1 << 1, FOCUSER_CAN_ABORT = 1 << 2, FOCUSER_HAS_VARIABLE_SPEED = 1 << 3 }

enum	FocusDirection { FOCUS_INWARD, FOCUS_OUTWARD, FOCUS_INWARD, FOCUS_OUTWARD }

enum	{ FOCUSER_CAN_ABS_MOVE = 1 << 0, FOCUSER_CAN_REL_MOVE = 1 << 1, FOCUSER_CAN_ABORT = 1 << 2, FOCUSER_HAS_VARIABLE_SPEED = 1 << 3 }

Public Member Functions
	FocusLynxBase ()

	FocusLynxBase (const char *target)

	~FocusLynxBase ()

virtual bool	Handshake () override
	perform handshake with device to check communication More...

virtual const char *	getDefaultName () override

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

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

virtual bool	updateProperties () override
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. More...

virtual bool	saveConfigItems (FILE *fp) override
	saveConfigItems Saves the Device Port and Focuser Presets in the configuration file More...

virtual bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n) override
	Process the client newNumber command. More...

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n) override
	Process the client newSwitch command. More...

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n) override
	Process the client newSwitch command. More...

virtual IPState	MoveAbsFocuser (uint32_t targetPosition) override
	MoveFocuser the focuser to an absolute position. More...

virtual IPState	MoveRelFocuser (FocusDirection dir, uint32_t ticks) override
	MoveFocuser the focuser to an relative position. More...

virtual IPState	MoveFocuser (FocusDirection dir, int speed, uint16_t duration) override
	MoveFocuser the focuser in a particular direction with a specific speed for a finite duration. More...

virtual bool	AbortFocuser () override
	AbortFocuser all focus motion. More...

virtual void	TimerHit () override
	Callback function to be called once SetTimer duration elapses. More...

virtual int	getVersion (int major, int minor, int *sub)

void	setFocusTarget (const char *target)

const char *	getFocusTarget ()

virtual void	debugTriggered (bool enable) override
	Inform driver that the debug option was triggered. More...

bool	setDeviceType (int index)

bool	ack ()

bool	isResponseOK ()

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

virtual	~Focuser ()

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	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. More...

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

uint8_t	getSupportedConnections () const

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

virtual	~DefaultDevice ()

void	addAuxControls ()
	Add Debug, Simulation, and Configuration options to the driver. More...

void	addDebugControl ()
	Add Debug control to the driver. More...

void	addSimulationControl ()
	Add Simulation control to the driver. More...

void	addConfigurationControl ()
	Add Configuration control to the driver. More...

void	addPollPeriodControl ()
	Add Polling period control to the driver. More...

void	resetProperties ()
	Set all properties to IDLE state. More...

void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. More...

void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. More...

void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. More...

void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. More...

void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. More...

virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. More...

virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client. More...

int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds. More...

void	RemoveTimer (int id)
	Remove timer added with SetTimer. More...

virtual const char *	getDriverExec ()

virtual const char *	getDriverName ()

void	setVersion (uint16_t vMajor, uint16_t vMinor)
	Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...

uint16_t	getMajorVersion ()

uint16_t	getMinorVersion ()

virtual bool	ISNewBLOB (const char dev, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)
	Process the client newBLOB command. More...

virtual uint16_t	getDriverInterface ()

void	setDriverInterface (uint16_t value)
	setInterface Set driver interface. More...

	DefaultDevice ()

virtual	~DefaultDevice ()

void	addAuxControls ()
	Add Debug, Simulation, and Configuration options to the driver. More...

void	addDebugControl ()
	Add Debug control to the driver. More...

void	addSimulationControl ()
	Add Simulation control to the driver. More...

void	addConfigurationControl ()
	Add Configuration control to the driver. More...

void	addPollPeriodControl ()
	Add Polling period control to the driver. More...

void	resetProperties ()
	Set all properties to IDLE state. More...

void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. More...

void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. More...

void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. More...

void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. More...

void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. More...

virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. More...

virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client. More...

int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds. More...

void	RemoveTimer (int id)
	Remove timer added with SetTimer. More...

virtual const char *	getDriverExec ()

virtual const char *	getDriverName ()

void	setVersion (uint16_t vMajor, uint16_t vMinor)
	Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...

uint16_t	getMajorVersion ()

uint16_t	getMinorVersion ()

virtual bool	ISNewBLOB (const char dev, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)
	Process the client newBLOB command. More...

virtual uint16_t	getDriverInterface ()

void	setDriverInterface (uint16_t value)
	setInterface Set driver interface. More...

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

virtual	~BaseDevice ()

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

Public Attributes
uint32_t	DBG_FOCUS

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

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

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

enum INDI::FocuserInterface:: { ... }	FocuserCapability

Protected Attributes
bool	configurationComplete

ISwitch *	ModelS

ISwitchVectorProperty	ModelSP

INumber	LedN [1]

INumberVectorProperty	LedNP

char	version [16]

Protected Attributes inherited from INDI::Focuser
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	getFocusConfig ()

bool	getFocusStatus ()

bool	setFocusPosition (u_int16_t position)

bool	setTemperatureCompensation (bool enable)

bool	setTemperatureCompensationMode (char mode)

bool	setTemperatureCompensationCoeff (char mode, int16_t coeff)

bool	setTemperatureCompensationOnStart (bool enable)

bool	setBacklashCompensation (bool enable)

bool	setBacklashCompensationSteps (uint16_t steps)

bool	sync (uint32_t position)

bool	stop ()

bool	home ()

bool	center ()

bool	reverse (bool enable)

bool	setLedLevel (int level)

bool	setDeviceNickname (const char *nickname)

bool	resetFactory ()

float	calcTimeLeft (timeval, float)

Private Attributes
uint32_t	simPosition

uint32_t	targetPosition

uint32_t	maxControllerTicks

ISState	simStatus [8]

bool	simCompensationOn

char	focusTarget [8]

std::map< std::string, std::string >	lynxModels

struct timeval	focusMoveStart

float	focusMoveRequest

INumber	TemperatureN [1]

INumberVectorProperty	TemperatureNP

ISwitch	TemperatureCompensateS [2]

ISwitchVectorProperty	TemperatureCompensateSP

ISwitch	TemperatureCompensateOnStartS [2]

ISwitchVectorProperty	TemperatureCompensateOnStartSP

INumber	TemperatureCoeffN [5]

INumberVectorProperty	TemperatureCoeffNP

ISwitch	TemperatureCompensateModeS [5]

ISwitchVectorProperty	TemperatureCompensateModeSP

ISwitch	BacklashCompensationS [2]

ISwitchVectorProperty	BacklashCompensationSP

INumber	BacklashN [1]

INumberVectorProperty	BacklashNP

ISwitch	ResetS [1]

ISwitchVectorProperty	ResetSP

ISwitch	ReverseS [2]

ISwitchVectorProperty	ReverseSP

ISwitch	GotoS [2]

ISwitchVectorProperty	GotoSP

ILight	StatusL [8]

ILightVectorProperty	StatusLP

INumber	SyncN [1]

INumberVectorProperty	SyncNP

INumber	MaxTravelN [1]

INumberVectorProperty	MaxTravelNP

IText	HFocusNameT [1] {}

ITextVectorProperty	HFocusNameTP

bool	isAbsolute

bool	isSynced

bool	isHoming

Additional Inherited Members
Static Public Member Functions inherited from INDI::Focuser
static void	buttonHelper (const char button_n, ISState state, void context)

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

Protected Member Functions inherited from INDI::Focuser
void	processButton (const char *button_n, ISState state)

void	processButton (const char *button_n, ISState state)

Protected Member Functions inherited from INDI::DefaultDevice
void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. More...

virtual bool	loadConfig (bool silent=false, const char *property=nullptr)
	Load the last saved configuration file. More...

virtual bool	saveConfig (bool silent=false, const char *property=nullptr)
	Save the current properties in a configuration file. More...

virtual bool	saveAllConfigItems (FILE *fp)
	saveAllConfigItems Save all the drivers' properties in the configuration file More...

virtual bool	loadDefaultConfig ()
	Load the default configuration file. More...

void	setDebug (bool enable)
	Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...

void	setSimulation (bool enable)
	Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...

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

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

Protected Member Functions inherited from INDI::BaseDevice
int	buildProp (XMLEle root, char errmsg)
	Build a property given the supplied XML element (defXXX) More...

int	setValue (XMLEle root, char errmsg)
	handle SetXXX commands from client More...

int	setBLOB (IBLOBVectorProperty pp, XMLEle root, char *errmsg)
	Parse and store BLOB in the respective vector. More...

int	buildProp (XMLEle root, char errmsg)
	Build a property given the supplied XML element (defXXX) More...

int	setValue (XMLEle root, char errmsg)
	handle SetXXX commands from client More...

int	setBLOB (IBLOBVectorProperty pp, XMLEle root, char *errmsg)
	Parse and store BLOB in the respective vector. More...

Protected Member Functions inherited from INDI::FocuserInterface
	FocuserInterface (DefaultDevice *defaultDevice)

virtual	~FocuserInterface ()=default

void	initProperties (const char *groupName)
	Initilize focuser properties. More...

bool	updateProperties ()
	updateProperties Define or Delete Rotator properties based on the connection status of the base device More...

bool	processNumber (const char dev, const char name, double values[], char *names[], int n)
	Process focus number properties. More...

bool	processSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process focus switch properties. More...

virtual bool	SetFocuserSpeed (int speed)
	SetFocuserSpeed Set Focuser speed. More...

	FocuserInterface (DefaultDevice *defaultDevice)

virtual	~FocuserInterface ()=default

void	initProperties (const char *groupName)
	Initilize focuser properties. More...

bool	updateProperties ()
	updateProperties Define or Delete Rotator properties based on the connection status of the base device More...

bool	processNumber (const char dev, const char name, double values[], char *names[], int n)
	Process focus number properties. More...

bool	processSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process focus switch properties. More...

virtual bool	SetFocuserSpeed (int speed)
	SetFocuserSpeed Set Focuser speed. More...

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
FOCUS_A_COEFF
FOCUS_B_COEFF
FOCUS_C_COEFF
FOCUS_D_COEFF
FOCUS_E_COEFF
FOCUS_F_COEFF

◆ anonymous enum

anonymous enum

Enumerator
GOTO_CENTER
GOTO_HOME

◆ LYNX_STATUS

enum FocusLynxBase::LYNX_STATUS

Enumerator
STATUS_MOVING
STATUS_HOMING
STATUS_HOMED
STATUS_FFDETECT
STATUS_TMPPROBE
STATUS_REMOTEIO
STATUS_HNDCTRL
STATUS_REVERSE
STATUS_UNKNOWN

Constructor & Destructor Documentation

◆ FocusLynxBase() [1/2]

FocusLynxBase::FocusLynxBase ( )

◆ FocusLynxBase() [2/2]

FocusLynxBase::FocusLynxBase ( const char * target )

◆ ~FocusLynxBase()

FocusLynxBase::~FocusLynxBase ( )

Member Function Documentation

◆ AbortFocuser()

bool FocusLynxBase::AbortFocuser ( )

overridevirtual

AbortFocuser all focus motion.

Returns: True if abort is successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

◆ ack()

bool FocusLynxBase::ack ( )

◆ calcTimeLeft()

float FocusLynxBase::calcTimeLeft	(	timeval	start,
		float	req
	)

private

◆ center()

bool FocusLynxBase::center ( )

private

◆ debugTriggered()

void FocusLynxBase::debugTriggered ( bool enable )

overridevirtual

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.

Parameters

enable If true, the debug option is set to ON.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FocusLynxF2.

◆ getDefaultName()

const char * FocusLynxBase::getDefaultName ( )

overridevirtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

Reimplemented in FocusLynxF2, and FocusLynxF1.

◆ getFocusConfig()

bool FocusLynxBase::getFocusConfig ( )

private

◆ getFocusStatus()

bool FocusLynxBase::getFocusStatus ( )

private

◆ getFocusTarget()

const char * FocusLynxBase::getFocusTarget ( )

◆ getVersion()

int FocusLynxBase::getVersion	(	int *	major,
		int *	minor,
		int *	sub
	)

virtual

◆ Handshake()

bool FocusLynxBase::Handshake ( )

overridevirtual

perform handshake with device to check communication

Reimplemented from INDI::Focuser.

◆ home()

bool FocusLynxBase::home ( )

private

◆ initProperties()

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

Reimplemented in FocusLynxF2, and FocusLynxF1.

◆ ISGetProperties()

void FocusLynxBase::ISGetProperties ( const char * dev )

overridevirtual

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

◆ ISNewNumber()

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

overridevirtual

Process the client newNumber command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Focuser.

◆ ISNewSwitch()

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

overridevirtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Focuser.

◆ ISNewText()

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

overridevirtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Focuser.

◆ isResponseOK()

bool FocusLynxBase::isResponseOK ( )

◆ MoveAbsFocuser()

IPState FocusLynxBase::MoveAbsFocuser ( uint32_t targetTicks )

overridevirtual

MoveFocuser the focuser to an absolute position.

Parameters

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

◆ MoveFocuser()

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

overridevirtual

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

Parameters

dir	Direction of focuser, either FOCUS_INWARD or FOCUS_OUTWARD.
speed	Speed of focuser if supported by the focuser.
duration	The timeout in milliseconds before the focus motion halts. Pass 0 to move indefinitely.

Returns: Return IPS_OK if motion is completed and focuser reached requested position. Return IPS_BUSY if focuser started motion to requested position and is in progress. Return IPS_ALERT if there is an error.

Reimplemented from INDI::FocuserInterface.

◆ MoveRelFocuser()

IPState FocusLynxBase::MoveRelFocuser	(	FocusDirection	dir,
		uint32_t	ticks
	)

overridevirtual

MoveFocuser the focuser to an relative position.

Parameters

dir	Direction of focuser, either FOCUS_INWARD or FOCUS_OUTWARD.
ticks	The 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.

◆ resetFactory()

bool FocusLynxBase::resetFactory ( )

private

◆ reverse()

bool FocusLynxBase::reverse ( bool enable )

private

◆ saveConfigItems()

bool FocusLynxBase::saveConfigItems ( FILE * fp )

overridevirtual

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

◆ setBacklashCompensation()

bool FocusLynxBase::setBacklashCompensation ( bool enable )

private

◆ setBacklashCompensationSteps()

bool FocusLynxBase::setBacklashCompensationSteps ( uint16_t steps )

private

◆ setDeviceNickname()

bool FocusLynxBase::setDeviceNickname ( const char * nickname )

private

◆ setDeviceType()

bool FocusLynxBase::setDeviceType ( int index )

◆ setFocusPosition()

bool FocusLynxBase::setFocusPosition ( u_int16_t position )

private

◆ setFocusTarget()

void FocusLynxBase::setFocusTarget ( const char * target )

◆ setLedLevel()

bool FocusLynxBase::setLedLevel ( int level )

private

◆ setTemperatureCompensation()

bool FocusLynxBase::setTemperatureCompensation ( bool enable )

private

◆ setTemperatureCompensationCoeff()

bool FocusLynxBase::setTemperatureCompensationCoeff	(	char	mode,
		int16_t	coeff
	)

private

◆ setTemperatureCompensationMode()

bool FocusLynxBase::setTemperatureCompensationMode ( char mode )

private

◆ setTemperatureCompensationOnStart()

bool FocusLynxBase::setTemperatureCompensationOnStart ( bool enable )

private

◆ stop()

bool FocusLynxBase::stop ( )

private

◆ sync()

bool FocusLynxBase::sync ( uint32_t position )

private

◆ TimerHit()

void FocusLynxBase::TimerHit ( )

overridevirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

◆ updateProperties()

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

Reimplemented in FocusLynxF1.

Member Data Documentation

◆ BacklashCompensationS

ISwitch FocusLynxBase::BacklashCompensationS[2]

private

◆ BacklashCompensationSP

ISwitchVectorProperty FocusLynxBase::BacklashCompensationSP

private

◆ BacklashN

INumber FocusLynxBase::BacklashN[1]

private

◆ BacklashNP

INumberVectorProperty FocusLynxBase::BacklashNP

private

◆ configurationComplete

bool FocusLynxBase::configurationComplete

protected

◆ DBG_FOCUS

uint32_t FocusLynxBase::DBG_FOCUS

◆ focusMoveRequest

float FocusLynxBase::focusMoveRequest

private

◆ focusMoveStart

struct timeval FocusLynxBase::focusMoveStart

private

◆ focusTarget

char FocusLynxBase::focusTarget[8]

private

◆ GotoS

ISwitch FocusLynxBase::GotoS[2]

private

◆ GotoSP

ISwitchVectorProperty FocusLynxBase::GotoSP

private

◆ HFocusNameT

IText FocusLynxBase::HFocusNameT[1] {}

private

◆ HFocusNameTP

ITextVectorProperty FocusLynxBase::HFocusNameTP

private

◆ isAbsolute

bool FocusLynxBase::isAbsolute

private

◆ isHoming

bool FocusLynxBase::isHoming

private

◆ isSynced

bool FocusLynxBase::isSynced

private

◆ LedN

INumber FocusLynxBase::LedN[1]

protected

◆ LedNP

INumberVectorProperty FocusLynxBase::LedNP

protected

◆ lynxModels

std::map<std::string, std::string> FocusLynxBase::lynxModels

private

◆ maxControllerTicks

uint32_t FocusLynxBase::maxControllerTicks

private

◆ MaxTravelN

INumber FocusLynxBase::MaxTravelN[1]

private

◆ MaxTravelNP

INumberVectorProperty FocusLynxBase::MaxTravelNP

private

◆ ModelS

ISwitch* FocusLynxBase::ModelS

protected

◆ ModelSP

ISwitchVectorProperty FocusLynxBase::ModelSP

protected

◆ ResetS

ISwitch FocusLynxBase::ResetS[1]

private

◆ ResetSP

ISwitchVectorProperty FocusLynxBase::ResetSP

private

◆ ReverseS

ISwitch FocusLynxBase::ReverseS[2]

private

◆ ReverseSP

ISwitchVectorProperty FocusLynxBase::ReverseSP

private

◆ simCompensationOn

bool FocusLynxBase::simCompensationOn

private

◆ simPosition

uint32_t FocusLynxBase::simPosition

private

◆ simStatus

ISState FocusLynxBase::simStatus[8]

private

◆ StatusL

ILight FocusLynxBase::StatusL[8]

private

◆ StatusLP

ILightVectorProperty FocusLynxBase::StatusLP

private

◆ SyncN

INumber FocusLynxBase::SyncN[1]

private

◆ SyncNP

INumberVectorProperty FocusLynxBase::SyncNP

private

◆ targetPosition

uint32_t FocusLynxBase::targetPosition

private

◆ TemperatureCoeffN

INumber FocusLynxBase::TemperatureCoeffN[5]

private

◆ TemperatureCoeffNP

INumberVectorProperty FocusLynxBase::TemperatureCoeffNP

private

◆ TemperatureCompensateModeS

ISwitch FocusLynxBase::TemperatureCompensateModeS[5]

private

◆ TemperatureCompensateModeSP

ISwitchVectorProperty FocusLynxBase::TemperatureCompensateModeSP

private

◆ TemperatureCompensateOnStartS

ISwitch FocusLynxBase::TemperatureCompensateOnStartS[2]

private

◆ TemperatureCompensateOnStartSP

ISwitchVectorProperty FocusLynxBase::TemperatureCompensateOnStartSP

private

◆ TemperatureCompensateS

ISwitch FocusLynxBase::TemperatureCompensateS[2]

private

◆ TemperatureCompensateSP

ISwitchVectorProperty FocusLynxBase::TemperatureCompensateSP

private

◆ TemperatureN

INumber FocusLynxBase::TemperatureN[1]

private

◆ TemperatureNP

INumberVectorProperty FocusLynxBase::TemperatureNP

private

◆ version

char FocusLynxBase::version[16]

protected

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

ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/focuser/focuslynxbase.h
ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/focuser/focuslynxbase.cpp

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ LYNX_STATUS

Constructor & Destructor Documentation

◆ FocusLynxBase() [1/2]

◆ FocusLynxBase() [2/2]

◆ ~FocusLynxBase()

Member Function Documentation

◆ AbortFocuser()

◆ ack()

◆ calcTimeLeft()

◆ center()

◆ debugTriggered()

◆ getDefaultName()

◆ getFocusConfig()

◆ getFocusStatus()

◆ getFocusTarget()

◆ getVersion()

◆ Handshake()

◆ home()

◆ initProperties()

◆ ISGetProperties()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ ISNewText()

◆ isResponseOK()

◆ MoveAbsFocuser()

◆ MoveFocuser()

◆ MoveRelFocuser()

◆ resetFactory()

◆ reverse()

◆ saveConfigItems()

◆ setBacklashCompensation()

◆ setBacklashCompensationSteps()

◆ setDeviceNickname()

◆ setDeviceType()

◆ setFocusPosition()

◆ setFocusTarget()

◆ setLedLevel()

◆ setTemperatureCompensation()

◆ setTemperatureCompensationCoeff()

◆ setTemperatureCompensationMode()

◆ setTemperatureCompensationOnStart()

◆ stop()

◆ sync()

◆ TimerHit()

◆ updateProperties()

Member Data Documentation

◆ BacklashCompensationS

◆ BacklashCompensationSP

◆ BacklashN

◆ BacklashNP

◆ configurationComplete

◆ DBG_FOCUS

◆ focusMoveRequest

◆ focusMoveStart

◆ focusTarget

◆ GotoS

◆ GotoSP

◆ HFocusNameT

◆ HFocusNameTP

◆ isAbsolute

◆ isHoming

◆ isSynced

◆ LedN

◆ LedNP

◆ lynxModels

◆ maxControllerTicks

◆ MaxTravelN

◆ MaxTravelNP

◆ ModelS

◆ ModelSP