#include <alpaca_dome.h>

Inheritance diagram for AlpacaDome:

Public Member Functions
	AlpacaDome ()

virtual	~AlpacaDome ()=default

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

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

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

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

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

bool	CanFindHome ()

bool	CanCalibrate ()

bool	CanPark ()

bool	CanSetAltitude ()

bool	CanSetAzimuth ()

bool	CanSetPark ()

bool	CanSetShutter ()

bool	CanSlave ()

bool	CanSyncAzimuth ()

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

virtual	~Dome ()

virtual bool	ISSnoopDevice (XMLEle *root) override
	Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver.

void	setDomeConnection (const uint8_t &value)
	setDomeConnection Set Dome connection mode. Child class should call this in the constructor before Dome registers any connection interfaces

uint8_t	getDomeConnection () const

uint32_t	GetDomeCapability () const
	GetDomeCapability returns the capability of the dome.

void	SetDomeCapability (uint32_t cap)
	SetDomeCapability set the dome capabilities. All capabilities must be initialized.

bool	CanAbort ()

bool	CanAbsMove ()

bool	CanRelMove ()

bool	CanPark ()

bool	CanSync ()

bool	HasShutter ()

bool	HasVariableSpeed ()

bool	HasBacklash ()

bool	isLocked ()
	isLocked, is the dome currently locked?

DomeState	getDomeState () const

void	setDomeState (const DomeState &value)

ShutterState	getShutterState () const

void	setShutterState (const ShutterState &value)

IPState	getMountState () const

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

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

Protected Types
enum	{ HOST , PORT }

enum	{ TIMEOUT , RW_TIMEOUT }

enum	{ OPERATION_FIND_HOME , OPERATION_CALIBRATE }

enum	{ INFO_DEVICE_NAME , INFO_DESCRIPTION , INFO_DRIVER_INFO , INFO_DRIVER_VERSION , INFO_INTERFACE_VERSION }

Protected Types inherited from INDI::Dome
enum	{ ACTIVE_MOUNT , ACTIVE_INPUT , ACTIVE_OUTPUT }

enum	{ SHUTTER_CLOSE_ON_PARK , SHUTTER_OPEN_ON_UNPARK }

enum	{ DM_OTA_SIDE_EAST , DM_OTA_SIDE_WEST , DM_OTA_SIDE_MOUNT , DM_OTA_SIDE_HA , DM_OTA_SIDE_IGNORE }

Protected Member Functions
virtual const char *	getDefaultName () override

virtual bool	initProperties () override
	Initialize properties state and value for Alpaca dome device.

virtual bool	updateProperties () override
	Called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to activate or not the driver information and the specific Alpaca operations switches.

virtual bool	saveConfigItems (FILE *fp) override
	Save all dome parameters in the configuration file. This overridden method adds the HTTP connection info to the Alpaca device and its device number into the configuration file.

virtual bool	Connect () override
	Connect to the remote dome device. For Alpaca drivers, this method tries to connect to the device using the Alpaca Rest API, using HTTP (or HTTPS). The exact calls made depend on the interface version returned by the device.

virtual bool	Disconnect () override
	Disconnect from the remote dome device.

virtual bool	SetSpeed (double rpm) override
	Set Dome speed. This does not initiate motion, it sets the speed for the next motion command. If motion is in progress, then change speed accordingly.

virtual IPState	MoveRel (double azDiff) override
	Move the Dome to an relative position.

virtual IPState	MoveAbs (double az) override
	Move the Dome to an absolute azimuth.

virtual IPState	Move (DomeDirection dir, DomeMotionCommand operation) override
	Move the Dome in a particular direction.

virtual bool	Sync (double az) override
	Set the dome current azimuth with the supplied azimuth position.

virtual bool	Abort () override
	Abort all dome motion (spinning and shutter).

virtual IPState	Park () override
	Park the dome.

virtual IPState	UnPark () override
	UnPark the dome. The action of the Unpark command is dome specific, but it may include opening the shutter and moving to home position. However, in most cases, the dome stays in the current position and it starts waiting for incoming requests from the observatory (when parked, the dome often cannot be moved).

virtual IPState	ControlShutter (ShutterOperation operation) override
	Open or Close the shutter.

virtual bool	SetCurrentPark () override
	Set parking position of the dome with the current position.

virtual bool	SetDefaultPark () override
	Set parking position of the dome with the current position.

virtual IPState	FindHome ()
	Request the dome for moving and finding its Home position. The method is asynchronous and the dome should stop automatically as soon as it hits the Home reference point. Then, its current internal index (the origin for steps counter) is reset to zero.

virtual IPState	Calibrate ()
	Request the dome for moving in order to calibrate itself. The calibration is an asynchronous process and the method returns immediatly. The dome needs to be stopped using the Abort method.

virtual std::string	getAlpacaURL (const std::string &endpoint)

virtual std::string	buildAlpacaFormData (const nlohmann::json &request)

virtual void	setDefaultServerAddress (const char host, const char port, bool force=false)

virtual uint32_t	getTransactionId ()

Protected Member Functions inherited from INDI::Dome
virtual bool	SetBacklash (int32_t steps)
	SetBacklash Set the dome backlash compensation value.

virtual bool	SetBacklashEnabled (bool enabled)
	SetBacklashEnabled Enables or disables the dome backlash compensation.

const char *	GetShutterStatusString (ShutterState status)
	getShutterStatusString

void	SetParkDataType (DomeParkData type)
	setParkDataType Sets the type of parking data stored in the park data file and presented to the user.

bool	InitPark ()
	InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position. InitPark() should be called after successful connection to the dome on startup.

bool	isParked ()
	isParked is dome currently parked?

void	SetParked (bool isparked)
	SetParked Change the mount parking status. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process.

double	GetAxis1Park ()

double	GetAxis1ParkDefault ()

void	SetAxis1Park (double value)
	SetRAPark Set current AZ parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process.

void	SetAxis1ParkDefault (double steps)
	SetAxis1Park Set default AZ parking position.

const char *	LoadParkData ()

bool	WriteParkData ()

bool	GetTargetAz (double &Az, double &Alt, double &minAz, double &maxAz)
	GetTargetAz.

bool	Intersection (point3D p1, point3D p2, double r, double &mu1, double &mu2)
	Intersection Calculate the intersection of a ray and a sphere. The line segment is defined from p1 to p2. The sphere is of radius r and centered at (0,0,0). From http://local.wasp.uwa.edu.au/~pbourke/geometry/sphereline/ There are potentially two points of intersection given by p := p1 + mu1 (p2 - p1) p := p1 + mu2 (p2 - p1)

bool	OpticalCenter (point3D MountCenter, double dOpticalAxis, double Lat, double Ah, point3D &OP)
	OpticalCenter This function calculates the distance from the optical axis to the Dome center.

bool	OpticalVector (double Az, double Alt, point3D &OV)
	OpticalVector This function calculates a second point for determining the optical axis.

bool	CheckHorizon (double HA, double dec, double lat)
	CheckHorizon Returns true if telescope points above horizon.

void	UpdateMountCoords ()
	updateCoords updates the horizontal coordinates (Az & Alt) of the mount from the snooped RA, DEC and observer's location.

virtual void	UpdateAutoSync ()
	UpdateAutoSync This function calculates the target dome azimuth from the mount's target coordinates given the dome parameters. If the difference between the dome's and mount's azimuth angles exceeds the AutoSync threshold, the dome will be commanded to sync to the mount azimuth position.

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

virtual void	ActiveDevicesUpdated ()

double	Csc (double x)

double	Sec (double x)

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

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 Attributes
INDI::PropertyText	ServerAddressTP {2}
	Additional properties.

INDI::PropertyNumber	DeviceNumberNP {1}

INDI::PropertyNumber	ConnectionSettingsNP {2}

INDI::PropertySwitch	OperationSP {2}

INDI::PropertyText	InfoTP {5}

Protected Attributes inherited from INDI::Dome
INDI::PropertyNumber	DomeSpeedNP {1}

INDI::PropertySwitch	DomeMotionSP {2}

INDI::PropertyNumber	DomeAbsPosNP {1}

INDI::PropertyNumber	DomeRelPosNP {1}

INDI::PropertySwitch	AbortSP {1}

INDI::PropertyNumber	DomeParamNP {1}

INDI::PropertyNumber	DomeSyncNP {1}

INDI::PropertySwitch	DomeShutterSP {2}

INDI::PropertySwitch	ParkSP {2}

INDI::PropertyNumber	ParkPositionNP {1}

INDI::PropertySwitch	ParkOptionSP {3}

INDI::PropertyText	ActiveDeviceTP {3}

INDI::PropertySwitch	MountPolicySP {2}

INDI::PropertySwitch	ShutterParkPolicySP {2}

INDI::PropertyNumber	PresetNP {3}

INDI::PropertySwitch	PresetGotoSP {3}

INDI::PropertyNumber	DomeMeasurementsNP {6}

INDI::PropertySwitch	OTASideSP {5}

int	mountOTASide = 0

INDI::PropertySwitch	DomeAutoSyncSP {2}

INDI::PropertySwitch	DomeBacklashSP {2}

INDI::PropertyNumber	DomeBacklashNP {1}

uint32_t	capability

DomeParkData	parkDataType

double	prev_az

double	prev_alt

double	prev_ra

double	prev_dec

int	PortFD = -1

Connection::Serial *	serialConnection = nullptr

Connection::TCP *	tcpConnection = nullptr

DomeState	m_DomeState

ShutterState	m_ShutterState

IPState	m_MountState

IGeographicCoordinates	observer

bool	HaveLatLong = false

INDI::IHorizontalCoordinates	mountHoriztonalCoords

INDI::IEquatorialCoordinates	mountEquatorialCoords

bool	HaveRaDec = false

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

Additional Inherited Members
Public Types inherited from INDI::Dome
enum	DomeMeasurements { DM_DOME_RADIUS , DM_SHUTTER_WIDTH , DM_NORTH_DISPLACEMENT , DM_EAST_DISPLACEMENT , DM_UP_DISPLACEMENT , DM_OTA_OFFSET }
	Measurements necessary for dome-slit synchronization. All values are in meters. The displacements are measured from the true dome centre, and the dome is assumed spherical. More...

enum	DomeDirection { DOME_CW , DOME_CCW }

enum	DomeMotionCommand { MOTION_START , MOTION_STOP }

enum	DomeParkData { PARK_NONE , PARK_AZ , PARK_AZ_ENCODER }

enum	ShutterOperation { SHUTTER_OPEN , SHUTTER_CLOSE }
	Shutter operation command. More...

enum	MountLockingPolicy { MOUNT_IGNORED , MOUNT_LOCKS }

enum	DomeState { DOME_IDLE , DOME_MOVING , DOME_SYNCED , DOME_PARKING , DOME_UNPARKING , DOME_PARKED , DOME_UNPARKED , DOME_UNKNOWN , DOME_ERROR }
	Dome status. More...

enum	ShutterState { SHUTTER_OPENED , SHUTTER_CLOSED , SHUTTER_MOVING , SHUTTER_UNKNOWN , SHUTTER_ERROR }

enum	{ DOME_CAN_ABORT = 1 << 0 , DOME_CAN_ABS_MOVE = 1 << 1 , DOME_CAN_REL_MOVE = 1 << 2 , DOME_CAN_PARK = 1 << 3 , DOME_CAN_SYNC = 1 << 4 , DOME_HAS_SHUTTER = 1 << 5 , DOME_HAS_VARIABLE_SPEED = 1 << 6 , DOME_HAS_BACKLASH = 1 << 7 }

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

Public Types inherited from INDI::ParentDevice
enum	Type { Valid , Invalid }

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

enum	{ INDI_ENABLED , INDI_DISABLED }

enum	WATCH { WATCH_NEW = 0 , WATCH_UPDATE , WATCH_NEW_OR_UPDATE }

enum	DRIVER_INTERFACE { GENERAL_INTERFACE = 0 , TELESCOPE_INTERFACE = (1 << 0) , CCD_INTERFACE = (1 << 1) , GUIDER_INTERFACE = (1 << 2) , FOCUSER_INTERFACE = (1 << 3) , FILTER_INTERFACE = (1 << 4) , DOME_INTERFACE = (1 << 5) , GPS_INTERFACE = (1 << 6) , WEATHER_INTERFACE = (1 << 7) , AO_INTERFACE = (1 << 8) , DUSTCAP_INTERFACE = (1 << 9) , LIGHTBOX_INTERFACE = (1 << 10) , DETECTOR_INTERFACE = (1 << 11) , ROTATOR_INTERFACE = (1 << 12) , SPECTROGRAPH_INTERFACE = (1 << 13) , CORRELATOR_INTERFACE = (1 << 14) , AUX_INTERFACE = (1 << 15) , 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

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

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

Public Attributes inherited from INDI::Dome
enum INDI::Dome:: { ... }	DomeConnection

Detailed Description

Definition at line 42 of file alpaca_dome.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
HOST
PORT

Definition at line 305 of file alpaca_dome.h.

◆ anonymous enum

anonymous enum

protected

Enumerator
TIMEOUT
RW_TIMEOUT

Definition at line 314 of file alpaca_dome.h.

◆ anonymous enum

anonymous enum

protected

Enumerator
OPERATION_FIND_HOME
OPERATION_CALIBRATE

Definition at line 321 of file alpaca_dome.h.

◆ anonymous enum

anonymous enum

protected

Enumerator
INFO_DEVICE_NAME
INFO_DESCRIPTION
INFO_DRIVER_INFO
INFO_DRIVER_VERSION
INFO_INTERFACE_VERSION

Definition at line 329 of file alpaca_dome.h.

Constructor & Destructor Documentation

◆ AlpacaDome()

AlpacaDome::AlpacaDome ( )

Definition at line 43 of file alpaca_dome.cpp.

◆ ~AlpacaDome()

virtual AlpacaDome::~AlpacaDome ( )

virtualdefault

Member Function Documentation

◆ Abort()

bool AlpacaDome::Abort ( )

overrideprotectedvirtual

Abort all dome motion (spinning and shutter).

Returns: True if abort is successful, false otherwise.

Reimplemented from INDI::Dome.

Definition at line 460 of file alpaca_dome.cpp.

◆ buildAlpacaFormData()

std::string AlpacaDome::buildAlpacaFormData ( const nlohmann::json & request )

protectedvirtual

Definition at line 639 of file alpaca_dome.cpp.

◆ Calibrate()

IPState AlpacaDome::Calibrate ( )

protectedvirtual

Request the dome for moving in order to calibrate itself. The calibration is an asynchronous process and the method returns immediatly. The dome needs to be stopped using the Abort method.

Returns: IPS_BUSY if Dome Calibration is running, IPS_ALERT if there is an error.

Definition at line 624 of file alpaca_dome.cpp.

◆ CanCalibrate()

bool AlpacaDome::CanCalibrate ( )

inline

Returns: True if the dome can proceed calibration.

Definition at line 98 of file alpaca_dome.h.

◆ CanFindHome()

bool AlpacaDome::CanFindHome ( )

inline

Returns: True if the dome can find home position automatically.

Definition at line 90 of file alpaca_dome.h.

◆ CanPark()

bool AlpacaDome::CanPark ( )

inline

Returns: True if the dome can be parked.

Definition at line 106 of file alpaca_dome.h.

◆ CanSetAltitude()

bool AlpacaDome::CanSetAltitude ( )

inline

Returns: True if the dome altitude can be set.

Definition at line 114 of file alpaca_dome.h.

◆ CanSetAzimuth()

bool AlpacaDome::CanSetAzimuth ( )

inline

Returns: True if the dome azimuth can be set.

Definition at line 122 of file alpaca_dome.h.

◆ CanSetPark()

bool AlpacaDome::CanSetPark ( )

inline

Returns: True if the dome can set park position to the current azimuth angle.

Definition at line 130 of file alpaca_dome.h.

◆ CanSetShutter()

bool AlpacaDome::CanSetShutter ( )

inline

Returns: True if the dome can open or close the shutter.

Definition at line 138 of file alpaca_dome.h.

◆ CanSlave()

bool AlpacaDome::CanSlave ( )

inline

Returns: True if the dome is electronically slaved to the mount (ie. if this driver does not need to worry about computing geometry adjustments).

Definition at line 146 of file alpaca_dome.h.

◆ CanSyncAzimuth()

bool AlpacaDome::CanSyncAzimuth ( )

inline

Returns: True if the dome azimuth position can be synchronized with this driver.

Definition at line 154 of file alpaca_dome.h.

◆ Connect()

bool AlpacaDome::Connect ( )

overrideprotectedvirtual

Connect to the remote dome device. For Alpaca drivers, this method tries to connect to the device using the Alpaca Rest API, using HTTP (or HTTPS). The exact calls made depend on the interface version returned by the device.

Returns: True if connection is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 274 of file alpaca_dome.cpp.

◆ ControlShutter()

IPState AlpacaDome::ControlShutter ( ShutterOperation operation )

overrideprotectedvirtual

Open or Close the shutter.

Parameters

operation Either open or close the shutter.

Returns: IPS_OK if shutter operation is complete, IPS_BUSY if shutter operation is in progress, IPS_ALERT if there is an error.

Reimplemented from INDI::Dome.

Definition at line 538 of file alpaca_dome.cpp.

◆ Disconnect()

bool AlpacaDome::Disconnect ( )

overrideprotectedvirtual

Disconnect from the remote dome device.

Returns: True if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 348 of file alpaca_dome.cpp.

◆ FindHome()

IPState AlpacaDome::FindHome ( )

protectedvirtual

Request the dome for moving and finding its Home position. The method is asynchronous and the dome should stop automatically as soon as it hits the Home reference point. Then, its current internal index (the origin for steps counter) is reset to zero.

Returns: IPS_OK if Dome has found or is already at Home position, IPS_BUSY if Dome homing is in progress, IPS_ALERT if there is an error.

Definition at line 603 of file alpaca_dome.cpp.

◆ getAlpacaURL()

std::string AlpacaDome::getAlpacaURL ( const std::string & endpoint )

protectedvirtual

Definition at line 632 of file alpaca_dome.cpp.

◆ getDefaultName()

const char * AlpacaDome::getDefaultName ( void )

overrideprotectedvirtual

Returns: The default name of the device.

Implements INDI::DefaultDevice.

Definition at line 163 of file alpaca_dome.cpp.

◆ getTransactionId()

uint32_t AlpacaDome::getTransactionId ( )

protectedvirtual

Definition at line 695 of file alpaca_dome.cpp.

◆ initProperties()

bool AlpacaDome::initProperties ( )

overrideprotectedvirtual

Initialize properties state and value for Alpaca dome device.

Returns: True if initialization is successful, false otherwise.

Reimplemented from INDI::Dome.

Definition at line 170 of file alpaca_dome.cpp.

◆ ISGetProperties()

void AlpacaDome::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.

Reimplemented from INDI::Dome.

Definition at line 63 of file alpaca_dome.cpp.

◆ ISNewNumber()

bool AlpacaDome::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::Dome.

Definition at line 115 of file alpaca_dome.cpp.

◆ ISNewSwitch()

bool AlpacaDome::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::Dome.

Definition at line 75 of file alpaca_dome.cpp.

◆ ISNewText()

bool AlpacaDome::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::Dome.

Definition at line 146 of file alpaca_dome.cpp.

◆ Move()

IPState AlpacaDome::Move	(	DomeDirection	dir,
		DomeMotionCommand	operation
	)

overrideprotectedvirtual

Move the Dome in a particular direction.

Parameters

dir	Direction of Dome, either DOME_CW or DOME_CCW.

Returns: IPS_OK if dome operation is complete, IPS_BUSY if operation is in progress, IPS_ALERT on error.

Reimplemented from INDI::Dome.

Definition at line 405 of file alpaca_dome.cpp.

◆ MoveAbs()

IPState AlpacaDome::MoveAbs ( double az )

overrideprotectedvirtual

Move the Dome to an absolute azimuth.

Parameters

az	The new position of the Dome.

Returns: IPS_OK if motion is completed and Dome reached requested position, IPS_BUSY if Dome started motion to requested position and is in progress, IPS_ALERT on error.

Reimplemented from INDI::Dome.

Definition at line 390 of file alpaca_dome.cpp.

◆ MoveRel()

IPState AlpacaDome::MoveRel ( double azDiff )

overrideprotectedvirtual

Move the Dome to an relative position.

Parameters

azDiff The relative azimuth angle to move. Positive degree is clock-wise direction. Negative degrees is counter clock-wise direction.

Returns: IPS_OK if motion is completed and Dome reached requested position, IPS_BUSY if Dome started motion to requested position and is in progress, IPS_ALERT on error.

Reimplemented from INDI::Dome.

Definition at line 376 of file alpaca_dome.cpp.

◆ Park()

IPState AlpacaDome::Park ( )

overrideprotectedvirtual

Park the dome.

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

Reimplemented from INDI::Dome.

Definition at line 497 of file alpaca_dome.cpp.

◆ saveConfigItems()

bool AlpacaDome::saveConfigItems ( FILE * fp )

overrideprotectedvirtual

Save all dome parameters in the configuration file. This overridden method adds the HTTP connection info to the Alpaca device and its device number into the configuration file.

Parameters

fp	pointer to configuration file

Returns: True if successful, false otherwise.

Reimplemented from INDI::Dome.

Definition at line 261 of file alpaca_dome.cpp.

◆ SetCurrentPark()

bool AlpacaDome::SetCurrentPark ( )

overrideprotectedvirtual

Set parking position of the dome with the current position.

Returns: True if setting park position is successful, false otherwise.

Reimplemented from INDI::Dome.

Definition at line 576 of file alpaca_dome.cpp.

◆ SetDefaultPark()

bool AlpacaDome::SetDefaultPark ( )

overrideprotectedvirtual

Set parking position of the dome with the current position.

Note: This function performs exactly the same action as SetCurrentPark() does.

Returns: True if setting park position is successful, false otherwise.

Reimplemented from INDI::Dome.

Definition at line 596 of file alpaca_dome.cpp.

◆ setDefaultServerAddress()

void AlpacaDome::setDefaultServerAddress	(	const char *	host,
		const char *	port,
		bool	force = `false`
	)

protectedvirtual

Definition at line 675 of file alpaca_dome.cpp.

◆ SetSpeed()

bool AlpacaDome::SetSpeed ( double rpm )

overrideprotectedvirtual

Set Dome speed. This does not initiate motion, it sets the speed for the next motion command. If motion is in progress, then change speed accordingly.

Parameters

rpm	Dome speed (RPM)

Returns: True if successful, false otherwise.

Reimplemented from INDI::Dome.

Definition at line 368 of file alpaca_dome.cpp.

◆ Sync()

bool AlpacaDome::Sync ( double az )

overrideprotectedvirtual

Set the dome current azimuth with the supplied azimuth position.

Returns: True if syncing successful, false otherwise.

Reimplemented from INDI::Dome.

Definition at line 433 of file alpaca_dome.cpp.

◆ TimerHit()

void AlpacaDome::TimerHit ( )

overridevirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

Definition at line 52 of file alpaca_dome.cpp.

◆ UnPark()

IPState AlpacaDome::UnPark ( )

overrideprotectedvirtual

UnPark the dome. The action of the Unpark command is dome specific, but it may include opening the shutter and moving to home position. However, in most cases, the dome stays in the current position and it starts waiting for incoming requests from the observatory (when parked, the dome often cannot be moved).

Returns: IPS_OK if motion is completed and Dome is unparked, IPS_BUSY if Dome unparking is in progress, IPS_ALERT if there is an error.

Reimplemented from INDI::Dome.

Definition at line 519 of file alpaca_dome.cpp.

◆ updateProperties()

bool AlpacaDome::updateProperties ( )

overrideprotectedvirtual

Called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to activate or not the driver information and the specific Alpaca operations switches.

Returns: True if update is successful, false otherwise.

Reimplemented from INDI::Dome.

Definition at line 224 of file alpaca_dome.cpp.

Member Data Documentation

◆ ConnectionSettingsNP

INDI::PropertyNumber AlpacaDome::ConnectionSettingsNP {2}

protected

Definition at line 313 of file alpaca_dome.h.

◆ DeviceNumberNP

INDI::PropertyNumber AlpacaDome::DeviceNumberNP {1}

protected

Definition at line 311 of file alpaca_dome.h.

◆ InfoTP

INDI::PropertyText AlpacaDome::InfoTP {5}

protected

Definition at line 328 of file alpaca_dome.h.

◆ OperationSP

INDI::PropertySwitch AlpacaDome::OperationSP {2}

protected

Definition at line 320 of file alpaca_dome.h.

◆ ServerAddressTP

INDI::PropertyText AlpacaDome::ServerAddressTP {2}

protected

Additional properties.

Definition at line 304 of file alpaca_dome.h.

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ AlpacaDome()

◆ ~AlpacaDome()

Member Function Documentation

◆ Abort()

◆ buildAlpacaFormData()

◆ Calibrate()

◆ CanCalibrate()

◆ CanFindHome()

◆ CanPark()

◆ CanSetAltitude()

◆ CanSetAzimuth()

◆ CanSetPark()

◆ CanSetShutter()

◆ CanSlave()

◆ CanSyncAzimuth()

◆ Connect()

◆ ControlShutter()

◆ Disconnect()

◆ FindHome()

◆ getAlpacaURL()

◆ getDefaultName()

◆ getTransactionId()

◆ initProperties()

◆ ISGetProperties()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ ISNewText()

◆ Move()

◆ MoveAbs()

◆ MoveRel()

◆ Park()

◆ saveConfigItems()

◆ SetCurrentPark()

◆ SetDefaultPark()

◆ setDefaultServerAddress()

◆ SetSpeed()

◆ Sync()

◆ TimerHit()

◆ UnPark()

◆ updateProperties()

Member Data Documentation

◆ ConnectionSettingsNP

◆ DeviceNumberNP

◆ InfoTP

◆ OperationSP

◆ ServerAddressTP