The AvalonUPAS class drives the Avalon Instruments Universal Polar Alignment System (UPAS) via its GRBL-based serial protocol. More...

#include <avalon_upas.h>

Inheritance diagram for AvalonUPAS:

Public Member Functions
	AvalonUPAS ()

virtual	~AvalonUPAS () override=default

const char *	getDefaultName () override

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

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

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

virtual	~DefaultDevice () override=default

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

void	addDebugControl ()
	Add Debug control to the driver.

void	addSimulationControl ()
	Add Simulation control to the driver.

void	addConfigurationControl ()
	Add Configuration control to the driver.

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

void	addNicknameControl ()
	Add Nickname text property to the driver.

void	resetProperties ()
	Set all properties to IDLE state.

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.

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.

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.

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.

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.

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.

bool	deleteProperty (INDI::Property &property)
	deleteProperty Delete a property and unregister it. It will also be deleted from all clients.

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

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

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

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.

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.

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

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.

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.

bool	ISNewProperty (INDI::Property &property, const std::string &elementName, const std::any &value)
	Generic convenience function to update a property element as if by client request, simulating an ISNew... call.

template<typename PropertyType , typename ValueType >
bool	updateProperty (PropertyType &property, ValueType values, char names[], int n, std::function< bool()> updater, bool saveConfig=false)
	Generic helper function to update an INDI property based on an external operation.

uint32_t	getDriverInterface () const

void	setDriverInterface (uint32_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.

void	watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback)
	Add a device to the watch list.

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.

void	registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type)

int	removeProperty (const char name, char errmsg)
	Remove a property.

void	watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW)
	Call the callback function if property is available.

Property	getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
	Return a property and its type given its name.

Properties	getProperties ()
	Return a list of all properties in the device.

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.

void	addMessage (const std::string &msg)
	Add message to the driver's message queue.

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	isSameDevice (const BaseDevice &other) const

bool	isConnected () const

void	attach ()
	indicates that the device is ready

void	detach ()
	indicates that the device is being removed

void	setMediator (INDI::BaseMediator *mediator)
	Set the driver's mediator to receive notification of news devices and updated property values.

INDI::BaseMediator *	getMediator () const

void	setDeviceName (const char *dev)
	Set the device name.

const char *	getDeviceName () const

bool	isDeviceNameMatch (const char *otherName) const
	Check that the device name matches the argument.

bool	isDeviceNameMatch (const std::string &otherName) const
	Check that the device name matches the argument.

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.

bool	buildSkeleton (const char *filename)
	Build driver properties from a skeleton file.

int	buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false)
	Build a property given the supplied XML element (defXXX)

int	setValue (const INDI::LilXmlElement &root, char *errmsg)
	handle SetXXX commands from client

	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::PACInterface
uint32_t	GetCapability () const

void	SetCapability (uint32_t cap)
	SetCapability sets the PAC device capabilities. Call this in the driver constructor.

bool	HasSpeed ()

bool	CanReverse ()

bool	HasPosition ()

bool	CanHome ()

bool	HasBacklash ()

bool	CanSync ()

Protected Member Functions
bool	initProperties () override
	Initialize properties initial state and value. The child class must implement this function.

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.

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.

bool	Handshake ()

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

IPState	MoveAZ (double degrees) override
	Move the azimuth axis by the given number of degrees.

IPState	MoveALT (double degrees) override
	MoveALT Move the altitude axis by the given number of degrees.

IPState	MoveBoth (double azDegrees, double altDegrees) override
	MoveBoth Move both axes in a single coordinated operation.

bool	AbortMotion () override
	AbortMotion Abort all axis motion immediately.

bool	SetPACSpeed (uint16_t speed) override
	SetPACSpeed Set the motor speed used for axis movements.

bool	ReverseAZ (bool enabled) override
	ReverseAZ Reverse the direction of azimuth axis movement.

bool	ReverseALT (bool enabled) override
	ReverseALT Reverse the direction of altitude axis movement.

Protected Member Functions inherited from INDI::DefaultDevice
void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. Dynamic 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.

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

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.

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

bool	saveConfig (INDI::Property &property)
	Save a property in the configuration file.

virtual bool	purgeConfig ()
	purgeConfig Remove config file from disk.

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

virtual bool	loadDefaultConfig ()
	Load the default configuration file.

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

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

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.

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.

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.

virtual bool	Disconnect ()
	Disconnect from device.

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

bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool

Connection::Interface *	getActiveConnection ()

void	setActiveConnection (Connection::Interface *existingConnection)
	setActiveConnection Switch the active connection to the passed connection plugin

void	setDefaultPollingPeriod (uint32_t msec)
	setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver.

void	setPollingPeriodRange (uint32_t minimum, uint32_t maximum)
	setPollingPeriodRange Set the range permitted by the polling range in milliseconds

uint32_t	getPollingPeriod () const
	getPollingPeriod Return the polling period.

void	setCurrentPollingPeriod (uint32_t msec)
	setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver.

uint32_t	getCurrentPollingPeriod () const
	getCurrentPollingPeriod Return the current polling period.

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.

bool	isInitializationComplete () const
	isInitializationComplete Check if driver initialization is complete.

void	syncDriverInfo ()
	syncDriverInfo sends the current driver information to the client.

void	setDeviceNickname (const char *nick)
	Set the device nickname.

const char *	getDeviceNickname ()

const char *	lookupDeviceNicknameFromId (const char identifier, const char device=nullptr)
	Lookup device nickname for an identifier.

bool	setDeviceNicknameFromId (const char *identifier)
	Set device nickname based on an identifier.

void	saveNicknameId (const char nickname, const char identifier)

virtual void	nicknameSet (const char *nickname)
	Inform driver that the nickname has been set.

	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::PACInterface
	PACInterface (DefaultDevice *device)

virtual	~PACInterface ()=default

virtual bool	SetHome ()
	SetHome Mark the current position as the home (zero) reference.

virtual IPState	GoHome ()
	GoHome Slew both axes back to the home (0, 0) position.

virtual bool	ResetHome ()
	ResetHome Clear the stored home reference without moving.

virtual bool	SyncAZ (double degrees)
	SyncAZ Sync the azimuth position reference to the given value without moving.

virtual bool	SyncALT (double degrees)
	SyncALT Sync the altitude position reference to the given value without moving.

virtual bool	SetBacklashEnabled (bool enabled)
	SetBacklashEnabled Enable or disable hardware backlash compensation.

virtual bool	SetBacklashAZ (int32_t steps)
	SetBacklashAZ Set the azimuth axis backlash compensation value in steps.

virtual bool	SetBacklashALT (int32_t steps)
	SetBacklashALT Set the altitude axis backlash compensation value in steps.

void	initProperties (const char *group)
	initProperties Initialize PAC properties. Call this from your driver's initProperties().

bool	updateProperties ()
	updateProperties Define or delete properties based on connection state. Call this from your driver's updateProperties().

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

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

bool	saveConfigItems (FILE *fp)
	saveConfigItems Save PAC interface properties to config file. Call this from your driver's saveConfigItems().

Additional Inherited Members
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) , OUTPUT_INTERFACE = (1 << 16) , INPUT_INTERFACE = (1 << 17) , POWER_INTERFACE = (1 << 18) , IMU_INTERFACE = (1 << 19) , PAC_INTERFACE = (1 << 20) , 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::PACInterface
enum	{ MANUAL_AZ , MANUAL_ALT }

enum	{ POSITION_AZ , POSITION_ALT }

enum	{ PAC_HAS_SPEED = 1 << 0 , PAC_CAN_REVERSE = 1 << 1 , PAC_HAS_POSITION = 1 << 2 , PAC_CAN_HOME = 1 << 3 , PAC_HAS_BACKLASH = 1 << 4 , PAC_CAN_SYNC = 1 << 5 }
	PAC capability flags passed to SetCapability(). More...

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

Public Attributes inherited from INDI::PACInterface
enum INDI::PACInterface:: { ... }	PACCapability
	PAC capability flags passed to SetCapability().

Protected Types inherited from INDI::PACInterface
enum	{ HOME_SET , HOME_GO , HOME_RESET }

enum	{ SYNC_AZ , SYNC_ALT }

enum	{ BACKLASH_AZ , BACKLASH_ALT }

Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivate >	d_ptr

Protected Attributes inherited from INDI::PACInterface
INDI::PropertyNumber	ManualAdjustmentNP {2}

INDI::PropertySwitch	AbortSP {1}

INDI::PropertyNumber	PositionNP {2}

INDI::PropertyNumber	SpeedNP {1}

INDI::PropertySwitch	AZReverseSP {2}

INDI::PropertySwitch	ALTReverseSP {2}

INDI::PropertySwitch	HomeSP {3}

INDI::PropertyNumber	SyncNP {2}

INDI::PropertySwitch	BacklashSP {2}

INDI::PropertyNumber	BacklashNP {2}

Detailed Description

The AvalonUPAS class drives the Avalon Instruments Universal Polar Alignment System (UPAS) via its GRBL-based serial protocol.

Protocol summary:

Relative jog: $J=G91G21{X|Y}{mm} F{feed_rate}
(X = azimuth axis, Y = altitude axis; mm = degrees × gear_ratio)
Position query: ? → <State|MPos:az_mm,alt_mm|...>
Abort (jog cancel): 0x85 byte
Axis reverse: $3={mask}
(bit 0 = AZ, bit 1 = ALT)

Capabilities: PAC_HAS_SPEED | PAC_CAN_REVERSE | PAC_HAS_POSITION

Definition at line 42 of file avalon_upas.h.

Constructor & Destructor Documentation

◆ AvalonUPAS()

AvalonUPAS::AvalonUPAS ( )

Definition at line 37 of file avalon_upas.cpp.

◆ ~AvalonUPAS()

virtual AvalonUPAS::~AvalonUPAS ( )

overridevirtualdefault

Member Function Documentation

◆ AbortMotion()

bool AvalonUPAS::AbortMotion ( )

overrideprotectedvirtual

AbortMotion Abort all axis motion immediately.

The default implementation logs an error and returns false. Drivers that support hardware abort should override this method.

Returns: True if motion was successfully aborted, false otherwise.

Reimplemented from INDI::PACInterface.

Definition at line 290 of file avalon_upas.cpp.

◆ getDefaultName()

const char * AvalonUPAS::getDefaultName ( )

overridevirtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 44 of file avalon_upas.cpp.

◆ Handshake()

bool AvalonUPAS::Handshake ( )

protected

Definition at line 114 of file avalon_upas.cpp.

◆ initProperties()

bool AvalonUPAS::initProperties ( )

overrideprotectedvirtual

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

Returns: True if initialization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 49 of file avalon_upas.cpp.

◆ ISNewNumber()

bool AvalonUPAS::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 353 of file avalon_upas.cpp.

◆ ISNewSwitch()

bool AvalonUPAS::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 372 of file avalon_upas.cpp.

◆ MoveALT()

IPState AvalonUPAS::MoveALT ( double degrees )

overrideprotectedvirtual

MoveALT Move the altitude axis by the given number of degrees.

Sign convention: positive = North (increase altitude), negative = South.

The default implementation returns IPS_ALERT. Drivers with motorised altitude adjustment must override this method.

Parameters

degrees Signed step size in degrees.

Returns: IPS_OK if completed immediately, IPS_BUSY if in progress, IPS_ALERT on error.

Reimplemented from INDI::PACInterface.

Definition at line 238 of file avalon_upas.cpp.

◆ MoveAZ()

IPState AvalonUPAS::MoveAZ ( double degrees )

overrideprotectedvirtual

Move the azimuth axis by the given number of degrees.

Sign convention: positive = East, negative = West.

The default implementation returns IPS_ALERT. Drivers with motorised azimuth adjustment must override this method.

Parameters

degrees Signed step size in degrees.

Returns: IPS_OK if completed immediately, IPS_BUSY if in progress, IPS_ALERT on error.

Reimplemented from INDI::PACInterface.

Definition at line 213 of file avalon_upas.cpp.

◆ MoveBoth()

IPState AvalonUPAS::MoveBoth	(	double	azDegrees,
		double	altDegrees
	)

overrideprotectedvirtual

MoveBoth Move both axes in a single coordinated operation.

Called by processNumber() when both azStep and altStep are non-zero. The default implementation calls MoveAZ() followed by MoveALT(), preserving backward-compatible behaviour for any driver that does not override this method.

Drivers that can do better should override this:

Hardware with native dual-axis commands (e.g. GRBL) can pack both axes into a single serial command for truly simultaneous motion.
Hardware with shared angle registers that must sequence internally (e.g. MLAstro RPA) can send one chained command and let the device handle the AZ→ALT sequence on its own.

Parameters

azDegrees	Signed azimuth step in degrees (+East / −West).
altDegrees	Signed altitude step in degrees (+North / −South).

Returns: IPS_OK if completed immediately, IPS_BUSY if in progress, IPS_ALERT on error.

Reimplemented from INDI::PACInterface.

Definition at line 262 of file avalon_upas.cpp.

◆ ReverseALT()

bool AvalonUPAS::ReverseALT ( bool enabled )

overrideprotectedvirtual

ReverseALT Reverse the direction of altitude axis movement.

Only called when PAC_CAN_REVERSE capability is set.

Parameters

enabled True to reverse, false to restore normal direction.

Returns: True if successful, false otherwise.

Reimplemented from INDI::PACInterface.

Definition at line 335 of file avalon_upas.cpp.

◆ ReverseAZ()

bool AvalonUPAS::ReverseAZ ( bool enabled )

overrideprotectedvirtual

ReverseAZ Reverse the direction of azimuth axis movement.

Only called when PAC_CAN_REVERSE capability is set.

Parameters

enabled True to reverse, false to restore normal direction.

Returns: True if successful, false otherwise.

Reimplemented from INDI::PACInterface.

Definition at line 317 of file avalon_upas.cpp.

◆ saveConfigItems()

bool AvalonUPAS::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 106 of file avalon_upas.cpp.

◆ SetPACSpeed()

bool AvalonUPAS::SetPACSpeed ( uint16_t speed )

overrideprotectedvirtual

SetPACSpeed Set the motor speed used for axis movements.

Only called when PAC_HAS_SPEED capability is set. The default implementation logs an error and returns false; drivers with variable-speed hardware must override.

Parameters

speed Speed value (range defined by the driver, default 1–10).

Returns: True if the speed was applied successfully, false otherwise.

Reimplemented from INDI::PACInterface.

Definition at line 309 of file avalon_upas.cpp.

◆ TimerHit()

void AvalonUPAS::TimerHit ( )

overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

Definition at line 165 of file avalon_upas.cpp.

◆ updateProperties()

bool AvalonUPAS::updateProperties ( )

overrideprotectedvirtual

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 87 of file avalon_upas.cpp.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AvalonUPAS()

◆ ~AvalonUPAS()

Member Function Documentation

◆ AbortMotion()

◆ getDefaultName()

◆ Handshake()

◆ initProperties()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ MoveALT()

◆ MoveAZ()

◆ MoveBoth()

◆ ReverseALT()

◆ ReverseAZ()

◆ saveConfigItems()

◆ SetPACSpeed()

◆ TimerHit()

◆ updateProperties()