#include <pegasus_upb.h>

Inheritance diagram for PegasusUPB:

Public Types
enum	{ UPB_V1 , UPB_V2 }

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 }

Public Member Functions
	PegasusUPB ()

virtual bool	initProperties () override
	Initilize properties initial state and value. The child class must implement this function. More...

virtual bool	updateProperties () override
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before. More...

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

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

virtual bool	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 bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More...

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

ParentDevice &	operator= (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::BaseMediator *	getMediator () 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 * ()

BaseDevice *	operator-> ()

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 Member Functions
const char *	getDefaultName () override

virtual bool	saveConfigItems (FILE *fp) override
	saveConfigItems Save specific properties in the provide config file handler. Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file. More...

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

virtual IPState	MoveAbsFocuser (uint32_t targetTicks) 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 bool	AbortFocuser () override
	AbortFocuser all focus motion. More...

virtual bool	ReverseFocuser (bool enabled) override
	ReverseFocuser Reverse focuser motion direction. More...

virtual bool	SyncFocuser (uint32_t ticks) override
	SyncFocuser Set current position to ticks without moving the focuser. More...

virtual bool	SetFocuserBacklash (int32_t steps) override
	SetFocuserBacklash Set the focuser backlash compensation value. More...

virtual bool	SetFocuserBacklashEnabled (bool enabled) override
	SetFocuserBacklashEnabled Enables or disables the focuser backlash compensation. More...

virtual IPState	updateWeather () override
	updateWeather Update weather conditions from device or service. The function should not change the state of any property in the device as this is handled by Weather. It should only update the raw values. More...

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

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 bool	SetFocuserSpeed (int speed)
	SetFocuserSpeed Set Focuser speed. More...

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

virtual bool	SetFocuserMaxPosition (uint32_t ticks)
	SetFocuserMaxPosition Set Focuser Maximum position limit in the hardware. More...

bool	saveConfigItems (FILE *fp)
	saveConfigItems save focuser properties defined in the interface in config file More...

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

virtual	~WeatherInterface ()

void	initProperties (const char statusGroup, const char paramsGroup)
	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 weather number properties. More...

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

void	checkWeatherUpdate ()
	checkWeatherUpdate Calls updateWeather and update critical parameters accordingly. More...

void	addParameter (std::string name, std::string label, double numMinOk, double numMaxOk, double percWarning)
	addParameter Add a physical weather measurable parameter to the weather driver. The weather value has three zones: More...

bool	setCriticalParameter (std::string param)
	setCriticalParameter Set parameter that is considered critical to the operation of the observatory. The parameter state can affect the overall weather driver state which signals the client to take appropriate action depending on the severity of the state. More...

void	setParameterValue (std::string name, double value)
	setParameterValue Update weather parameter value More...

IPState	checkParameterState (const std::string &param) const
	checkParameterState Checks the given parameter against the defined bounds More...

IPState	checkParameterState (const INumber &parameter) const

bool	syncCriticalParameters ()
	updateWeatherState Send update weather state to client More...

Additional Inherited Members
Static Public Member Functions inherited from INDI::BaseDevice
static std::string	getSharedFilePath (std::string fileName)

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

Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivate >	d_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 }

DefaultDevice *	m_defaultDevice { nullptr }

Protected Attributes inherited from INDI::WeatherInterface
INumber *	ParametersN {nullptr}

INumberVectorProperty	ParametersNP

INumberVectorProperty *	ParametersRangeNP {nullptr}

uint8_t	nRanges {0}

ILight *	critialParametersL {nullptr}

ILightVectorProperty	critialParametersLP

INDI::PropertyNumber	UpdatePeriodNP {1}

INDI::PropertySwitch	RefreshSP {1}

INDI::PropertySwitch	OverrideSP {1}

Detailed Description

Definition at line 37 of file pegasus_upb.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
UPB_V1
UPB_V2

Definition at line 42 of file pegasus_upb.h.

Constructor & Destructor Documentation

◆ PegasusUPB()

PegasusUPB::PegasusUPB ( )

Definition at line 41 of file pegasus_upb.cpp.

Member Function Documentation

◆ AbortFocuser()

bool PegasusUPB::AbortFocuser ( )

overrideprotectedvirtual

AbortFocuser all focus motion.

Returns: True if abort is successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Definition at line 1005 of file pegasus_upb.cpp.

◆ getDefaultName()

const char * PegasusUPB::getDefaultName ( )

overrideprotectedvirtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 476 of file pegasus_upb.cpp.

◆ initProperties()

bool PegasusUPB::initProperties ( )

overridevirtual

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

Returns: True if initilization is successful, false otherwise.

Main Control Panel

Power Group

Dew Group

USB Group

Focuser Group

Firmware Group

Environment Group

Serial Connection

Reimplemented from INDI::DefaultDevice.

Definition at line 51 of file pegasus_upb.cpp.

◆ ISNewNumber()

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

Definition at line 773 of file pegasus_upb.cpp.

◆ ISNewSwitch()

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

Definition at line 549 of file pegasus_upb.cpp.

◆ ISNewText()

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

Definition at line 859 of file pegasus_upb.cpp.

◆ MoveAbsFocuser()

IPState PegasusUPB::MoveAbsFocuser ( uint32_t targetTicks )

overrideprotectedvirtual

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.

Definition at line 982 of file pegasus_upb.cpp.

◆ MoveRelFocuser()

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

overrideprotectedvirtual

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.

Definition at line 997 of file pegasus_upb.cpp.

◆ ReverseFocuser()

bool PegasusUPB::ReverseFocuser ( bool enabled )

overrideprotectedvirtual

ReverseFocuser Reverse focuser motion direction.

Parameters

enabled If 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 1019 of file pegasus_upb.cpp.

◆ saveConfigItems()

bool PegasusUPB::saveConfigItems ( FILE * fp )

overrideprotectedvirtual

saveConfigItems Save specific properties in the provide config file handler. Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file.

Parameters

fp	Pointer to config file handler

Returns: True if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 1281 of file pegasus_upb.cpp.

◆ SetFocuserBacklash()

bool PegasusUPB::SetFocuserBacklash ( int32_t steps )

overrideprotectedvirtual

SetFocuserBacklash Set the focuser backlash compensation value.

Parameters

steps value in absolute steps to compensate

Returns: True if successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Definition at line 1044 of file pegasus_upb.cpp.

◆ SetFocuserBacklashEnabled()

bool PegasusUPB::SetFocuserBacklashEnabled ( bool enabled )

overrideprotectedvirtual

SetFocuserBacklashEnabled Enables or disables the focuser backlash compensation.

Parameters

enable flag to enable or disable backlash compensation

Returns: True if successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Definition at line 1064 of file pegasus_upb.cpp.

◆ SyncFocuser()

bool PegasusUPB::SyncFocuser ( uint32_t ticks )

overrideprotectedvirtual

SyncFocuser Set current position to ticks without moving the focuser.

Parameters

ticks Desired new sync position.

Returns: True if successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

Definition at line 1034 of file pegasus_upb.cpp.

◆ TimerHit()

void PegasusUPB::TimerHit ( )

overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

Definition at line 1302 of file pegasus_upb.cpp.

◆ updateProperties()

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

Definition at line 358 of file pegasus_upb.cpp.

◆ updateWeather()

virtual IPState PegasusUPB::updateWeather ( )

inlineoverrideprotectedvirtual

updateWeather Update weather conditions from device or service. The function should not change the state of any property in the device as this is handled by Weather. It should only update the raw values.

Returns: Return overall state. The state should be IPS_OK if data is valid. IPS_BUSY if weather update is in progress. IPS_ALERT is there is an error. The clients will only accept values with IPS_OK state.

Reimplemented from INDI::WeatherInterface.

Definition at line 73 of file pegasus_upb.h.

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

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PegasusUPB()

Member Function Documentation

◆ AbortFocuser()

◆ getDefaultName()

◆ initProperties()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ ISNewText()

◆ MoveAbsFocuser()

◆ MoveRelFocuser()

◆ ReverseFocuser()

◆ saveConfigItems()

◆ SetFocuserBacklash()

◆ SetFocuserBacklashEnabled()

◆ SyncFocuser()

◆ TimerHit()

◆ updateProperties()

◆ updateWeather()