The PlaneWaveRotator class provides an INDI driver for the PlaneWave Series 5 rotator, communicating via the PWI4 HTTP API. More...

#include <planewave_rotator.h>

Inheritance diagram for PlaneWaveRotator:

Public Member Functions
	PlaneWaveRotator ()
	Constructor / Destructor.

virtual	~PlaneWaveRotator ()

virtual const char *	getDefaultName () override
	getDefaultName

virtual bool	initProperties () override
	initProperties

virtual bool	updateProperties () override
	updateProperties

virtual bool	Handshake () override
	Handshake — build the persistent HTTP client and verify connectivity.

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

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n) override
	ISNewSwitch.

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

virtual	~Rotator ()

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.

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

uint8_t	getRotatorConnection () 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	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::RotatorInterface
uint32_t	GetCapability () const
	GetRotatorCapability returns the capability of the Rotator.

void	SetCapability (uint32_t cap)
	SetRotatorCapability sets the Rotator capabilities. All capabilities must be initialized.

bool	CanAbort ()

bool	CanHome ()

bool	CanSync ()

bool	CanReverse ()

bool	HasBacklash ()

Protected Member Functions
virtual IPState	MoveRotator (double angle) override

virtual bool	AbortRotator () override
	AbortRotator — RotatorInterface virtual.

virtual bool	ReverseRotator (bool enabled) override

virtual void	TimerHit () override
	TimerHit — polling loop.

virtual bool	saveConfigItems (FILE *fp) override
	saveConfigItems

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::RotatorInterface
	RotatorInterface (DefaultDevice *defaultDevice)

void	initProperties (const char *groupName)
	Initialize Rotator properties. It is recommended to call this function within initProperties() of your primary device.

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

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

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

virtual bool	SyncRotator (double angle)
	SyncRotator Set current angle as the supplied angle without moving the rotator.

virtual IPState	HomeRotator ()
	HomeRotator Go to home position.

virtual bool	SetRotatorBacklash (int32_t steps)
	SetRotatorBacklash Set the Rotatorer backlash compensation value.

virtual bool	SetRotatorBacklashEnabled (bool enabled)
	SetRotatorBacklashEnabled Enables or disables the Rotator backlash compensation.

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

Additional Inherited Members
Public Types inherited from INDI::Rotator
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

Public Types inherited from INDI::RotatorInterface
enum	{ ROTATOR_CAN_ABORT = 1 << 0 , ROTATOR_CAN_HOME = 1 << 1 , ROTATOR_CAN_SYNC = 1 << 2 , ROTATOR_CAN_REVERSE = 1 << 3 , ROTATOR_HAS_BACKLASH = 1 << 4 }

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

Public Attributes inherited from INDI::Rotator
enum INDI::Rotator:: { ... }	RotatorConnection

Public Attributes inherited from INDI::RotatorInterface
enum INDI::RotatorInterface:: { ... }	RotatorCapability

Protected Attributes inherited from INDI::Rotator
INDI::PropertyNumber	PresetNP {3}

INDI::PropertySwitch	PresetGotoSP {3}

Connection::Serial *	serialConnection = nullptr

Connection::TCP *	tcpConnection = nullptr

int	PortFD = -1

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

Protected Attributes inherited from INDI::RotatorInterface
INDI::PropertyNumber	GotoRotatorNP {1}

INDI::PropertyNumber	SyncRotatorNP {1}

INDI::PropertySwitch	AbortRotatorSP {1}

INDI::PropertySwitch	HomeRotatorSP {1}

INDI::PropertySwitch	ReverseRotatorSP {2}

INDI::PropertySwitch	RotatorBacklashSP {2}

INDI::PropertyNumber	RotatorBacklashNP {1}

INDI::PropertyNumber	RotatorLimitsNP {1}

double	m_RotatorOffset {-1}

uint32_t	rotatorCapability = 0

DefaultDevice *	m_defaultDevice { nullptr }

Detailed Description

The PlaneWaveRotator class provides an INDI driver for the PlaneWave Series 5 rotator, communicating via the PWI4 HTTP API.

Connection: TCP (default host localhost, port 8220).

The driver exposes two positioning modes:

Field angle (GotoRotatorNP, 0-360°) → /rotator/goto_field
Mechanical (MechPositionNP, 0-360°) → /rotator/goto_mech

Both positions are updated on every poll from /status.

Definition at line 46 of file planewave_rotator.h.

Constructor & Destructor Documentation

◆ PlaneWaveRotator()

PlaneWaveRotator::PlaneWaveRotator ( )

Constructor / Destructor.

Definition at line 39 of file planewave_rotator.cpp.

◆ ~PlaneWaveRotator()

PlaneWaveRotator::~PlaneWaveRotator ( )

virtualdefault

Member Function Documentation

◆ AbortRotator()

bool PlaneWaveRotator::AbortRotator ( )

overrideprotectedvirtual

AbortRotator — RotatorInterface virtual.

Reimplemented from INDI::RotatorInterface.

Definition at line 311 of file planewave_rotator.cpp.

◆ getDefaultName()

const char * PlaneWaveRotator::getDefaultName ( void )

overridevirtual

getDefaultName

Implements INDI::DefaultDevice.

Definition at line 57 of file planewave_rotator.cpp.

◆ Handshake()

bool PlaneWaveRotator::Handshake ( )

overridevirtual

Handshake — build the persistent HTTP client and verify connectivity.

Reimplemented from INDI::Rotator.

Definition at line 134 of file planewave_rotator.cpp.

◆ initProperties()

bool PlaneWaveRotator::initProperties ( )

overridevirtual

initProperties

Reimplemented from INDI::Rotator.

Definition at line 65 of file planewave_rotator.cpp.

◆ ISNewNumber()

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

overridevirtual

ISNewNumber.

Reimplemented from INDI::Rotator.

Definition at line 244 of file planewave_rotator.cpp.

◆ ISNewSwitch()

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

overridevirtual

ISNewSwitch.

Reimplemented from INDI::Rotator.

Definition at line 206 of file planewave_rotator.cpp.

◆ MoveRotator()

IPState PlaneWaveRotator::MoveRotator ( double angle )

overrideprotectedvirtual

MoveRotator — RotatorInterface pure-virtual Moves to the given field angle (0–360°), honouring the reverse flag.

Implements INDI::RotatorInterface.

Definition at line 286 of file planewave_rotator.cpp.

◆ ReverseRotator()

bool PlaneWaveRotator::ReverseRotator ( bool enabled )

overrideprotectedvirtual

ReverseRotator — RotatorInterface virtual Direction reversal is handled entirely in software (in MoveRotator).

Reimplemented from INDI::RotatorInterface.

Definition at line 325 of file planewave_rotator.cpp.

◆ saveConfigItems()

bool PlaneWaveRotator::saveConfigItems ( FILE * fp )

overrideprotectedvirtual

saveConfigItems

Reimplemented from INDI::Rotator.

Definition at line 440 of file planewave_rotator.cpp.

◆ TimerHit()

void PlaneWaveRotator::TimerHit ( )

overrideprotectedvirtual

TimerHit — polling loop.

Reimplemented from INDI::DefaultDevice.

Definition at line 334 of file planewave_rotator.cpp.

◆ updateProperties()

bool PlaneWaveRotator::updateProperties ( )

overridevirtual

updateProperties

Reimplemented from INDI::Rotator.

Definition at line 109 of file planewave_rotator.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

◆ PlaneWaveRotator()

◆ ~PlaneWaveRotator()

Member Function Documentation

◆ AbortRotator()

◆ getDefaultName()

◆ Handshake()

◆ initProperties()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ MoveRotator()

◆ ReverseRotator()

◆ saveConfigItems()

◆ TimerHit()

◆ updateProperties()