#include <indirotator.h>

Inheritance diagram for INDI::Rotator:

Collaboration diagram for INDI::Rotator:

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

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

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

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

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

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

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

enum	{ ROTATOR_CAN_ABORT = 1 << 0, ROTATOR_CAN_HOME = 1 << 1, ROTATOR_CAN_SYNC = 1 << 2, ROTATOR_CAN_REVERSE = 1 << 3 }

Public Member Functions
	Rotator ()

virtual	~Rotator ()

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

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

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

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

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

void	setRotatorConnection (const uint8_t &value)
	setRotatorConnection Set Rotator connection mode. More...

uint8_t	getRotatorConnection () const

	Rotator ()

virtual	~Rotator ()

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

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

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

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

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

void	setRotatorConnection (const uint8_t &value)
	setRotatorConnection Set Rotator connection mode. More...

uint8_t	getRotatorConnection () const

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

virtual	~DefaultDevice ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual const char *	getDriverExec ()

virtual const char *	getDriverName ()

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

uint16_t	getMajorVersion ()

uint16_t	getMinorVersion ()

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

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

virtual bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. More...

virtual uint16_t	getDriverInterface ()

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

	DefaultDevice ()

virtual	~DefaultDevice ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual const char *	getDriverExec ()

virtual const char *	getDriverName ()

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

uint16_t	getMajorVersion ()

uint16_t	getMinorVersion ()

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

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

virtual bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. More...

virtual uint16_t	getDriverInterface ()

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

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

virtual	~BaseDevice ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (const char *name)

IPState	getPropertyState (const char *name)

IPerm	getPropertyPermission (const char *name)

void	registerProperty (void *p, INDI_PROPERTY_TYPE type)

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

void *	getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

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

std::vector< INDI::Property * > *	getProperties ()
	Return a list of all properties in the device. More...

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

bool	isConnected ()

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

const char *	getDeviceName ()

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

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

std::string	messageQueue (int index) const

std::string	lastMessage ()

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

INDI::BaseMediator *	getMediator ()

const char *	getDriverName ()

const char *	getDriverExec ()

const char *	getDriverVersion ()

	BaseDevice ()

virtual	~BaseDevice ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (const char *name)

IPState	getPropertyState (const char *name)

IPerm	getPropertyPermission (const char *name)

void	registerProperty (void *p, INDI_PROPERTY_TYPE type)

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

void *	getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

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

std::vector< INDI::Property * > *	getProperties ()
	Return a list of all properties in the device. More...

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

bool	isConnected ()

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

const char *	getDeviceName ()

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

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

std::string	messageQueue (int index) const

std::string	lastMessage ()

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

INDI::BaseMediator *	getMediator ()

const char *	getDriverName ()

const char *	getDriverExec ()

const char *	getDriverVersion ()

Public Member Functions inherited from INDI::RotatorInterface
uint32_t	GetCapability () const
	GetRotatorCapability returns the capability of the Rotator. More...

void	SetCapability (uint32_t cap)
	SetRotatorCapability sets the Rotator capabilities. More...

bool	CanAbort ()

bool	CanHome ()

bool	CanSync ()

bool	CanReverse ()

uint32_t	GetCapability () const
	GetRotatorCapability returns the capability of the Rotator. More...

void	SetCapability (uint32_t cap)
	SetRotatorCapability sets the Rotator capabilities. More...

bool	CanAbort ()

bool	CanHome ()

bool	CanSync ()

bool	CanReverse ()

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

enum INDI::Rotator:: { ... }	RotatorConnection

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

enum INDI::RotatorInterface:: { ... }	RotatorCapability

Protected Member Functions
virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Saves the reverse direction property in the configuration file More...

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

virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Saves the reverse direction property in the configuration file More...

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

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

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

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

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

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

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

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

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

virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. More...

bool	isDebug ()

bool	isSimulation ()

virtual bool	Connect ()
	Connect to the device. More...

virtual bool	Disconnect ()
	Disconnect from device. More...

void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. More...

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

Connection::Interface *	getActiveConnection ()

void	setDefaultPollingPeriod (uint32_t period)

uint32_t	getPollingPeriod ()

virtual const char *	getDefaultName ()=0

void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. More...

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

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

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

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

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

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

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

virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. More...

bool	isDebug ()

bool	isSimulation ()

virtual bool	Connect ()
	Connect to the device. More...

virtual bool	Disconnect ()
	Disconnect from device. More...

void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. More...

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

Connection::Interface *	getActiveConnection ()

void	setDefaultPollingPeriod (uint32_t period)

uint32_t	getPollingPeriod ()

virtual const char *	getDefaultName ()=0

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

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

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

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

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

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

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

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

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

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

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

virtual IPState	MoveRotator (double angle)=0
	MoveRotator Go to specific angle. More...

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

virtual IPState	HomeRotator ()
	HomeRotator Go to home position. More...

virtual bool	ReverseRotator (bool enabled)
	ReverseRotator Reverse the direction of the rotator. More...

virtual bool	AbortRotator ()
	AbortRotator Abort all motion. More...

	RotatorInterface (DefaultDevice *defaultDevice)

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

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

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

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

virtual IPState	MoveRotator (double angle)=0
	MoveRotator Go to specific angle. More...

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

virtual IPState	HomeRotator ()
	HomeRotator Go to home position. More...

virtual bool	ReverseRotator (bool enabled)
	ReverseRotator Reverse the direction of the rotator. More...

virtual bool	AbortRotator ()
	AbortRotator Abort all motion. More...

Protected Attributes
INumber	PresetN [3]

INumberVectorProperty	PresetNP

ISwitch	PresetGotoS [3]

ISwitchVectorProperty	PresetGotoSP

Connection::Serial *	serialConnection = NULL

Connection::TCP *	tcpConnection = NULL

int	PortFD = -1

Protected Attributes inherited from INDI::DefaultDevice
uint32_t	POLLMS = 1000
	Period in milliseconds to call TimerHit(). Default 1000 ms. More...

Protected Attributes inherited from INDI::RotatorInterface
INumber	GotoRotatorN [1]

INumberVectorProperty	GotoRotatorNP

INumber	SyncRotatorN [1]

INumberVectorProperty	SyncRotatorNP

ISwitch	AbortRotatorS [1]

ISwitchVectorProperty	AbortRotatorSP

ISwitch	HomeRotatorS [1]

ISwitchVectorProperty	HomeRotatorSP

ISwitch	ReverseRotatorS [2]

ISwitchVectorProperty	ReverseRotatorSP

uint32_t	rotatorCapability = 0

DefaultDevice *	m_defaultDevice { nullptr }

Private Member Functions
bool	callHandshake ()

bool	callHandshake ()

Private Attributes
uint8_t	rotatorConnection = CONNECTION_SERIAL \| CONNECTION_TCP

Additional Inherited Members
Protected Types inherited from INDI::RotatorInterface
enum	{ REVERSE_ENABLED, REVERSE_DISABLED }

enum	{ REVERSE_ENABLED, REVERSE_DISABLED }

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
CONNECTION_NONE
CONNECTION_SERIAL	Do not use any connection plugin.
CONNECTION_TCP	For regular serial and bluetooth connections.

◆ anonymous enum

anonymous enum

Enumerator
CONNECTION_NONE
CONNECTION_SERIAL	Do not use any connection plugin.
CONNECTION_TCP	For regular serial and bluetooth connections.

Constructor & Destructor Documentation

◆ Rotator() [1/2]

Rotator::Rotator ( )

◆ ~Rotator() [1/2]

Rotator::~Rotator ( )

virtual

◆ Rotator() [2/2]

INDI::Rotator::Rotator ( )

◆ ~Rotator() [2/2]

virtual INDI::Rotator::~Rotator ( )

virtual

Member Function Documentation

◆ callHandshake() [1/2]

bool Rotator::callHandshake ( )

private

◆ callHandshake() [2/2]

bool INDI::Rotator::callHandshake ( )

private

◆ getRotatorConnection() [1/2]

uint8_t INDI::Rotator::getRotatorConnection ( ) const

Returns: Get current Rotator connection mode

◆ getRotatorConnection() [2/2]

uint8_t Rotator::getRotatorConnection ( ) const

Returns: Get current Rotator connection mode

◆ Handshake() [1/2]

virtual bool INDI::Rotator::Handshake ( )

protectedvirtual

perform handshake with device to check communication

Reimplemented in Pyxis.

◆ Handshake() [2/2]

bool Rotator::Handshake ( )

protectedvirtual

perform handshake with device to check communication

Reimplemented in Pyxis.

◆ initProperties() [1/2]

virtual bool INDI::Rotator::initProperties ( )

virtual

Initilize properties initial state and value.

The child class must implement this function.

Returns: True if initilization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in Pyxis.

◆ initProperties() [2/2]

bool Rotator::initProperties ( )

virtual

Initilize properties initial state and value.

The child class must implement this function.

Returns: True if initilization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in Pyxis.

◆ ISGetProperties() [1/2]

void Rotator::ISGetProperties ( const char * dev )

virtual

define the driver's properties to the client.

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

Parameters

dev	name of the device

Note: This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::DefaultDevice.

◆ ISGetProperties() [2/2]

virtual void INDI::Rotator::ISGetProperties ( const char * dev )

virtual

define the driver's properties to the client.

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

Parameters

dev	name of the device

Note: This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::DefaultDevice.

◆ ISNewNumber() [1/2]

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

virtual

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.

Reimplemented in Pyxis.

◆ ISNewNumber() [2/2]

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

virtual

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.

Reimplemented in Pyxis.

◆ ISNewSwitch() [1/2]

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

virtual

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.

Reimplemented in Pyxis.

◆ ISNewSwitch() [2/2]

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

virtual

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.

Reimplemented in Pyxis.

◆ saveConfigItems() [1/2]

virtual bool INDI::Rotator::saveConfigItems ( FILE * fp )

protectedvirtual

saveConfigItems Saves the reverse direction property in the configuration file

Parameters

fp	pointer to configuration file

Returns: true if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ saveConfigItems() [2/2]

bool Rotator::saveConfigItems ( FILE * fp )

protectedvirtual

saveConfigItems Saves the reverse direction property in the configuration file

Parameters

fp	pointer to configuration file

Returns: true if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ setRotatorConnection() [1/2]

void Rotator::setRotatorConnection ( const uint8_t & value )

setRotatorConnection Set Rotator connection mode.

Child class should call this in the constructor before Rotator registers any connection interfaces

Parameters

value ORed combination of RotatorConnection values.

◆ setRotatorConnection() [2/2]

void INDI::Rotator::setRotatorConnection ( const uint8_t & value )

setRotatorConnection Set Rotator connection mode.

Child class should call this in the constructor before Rotator registers any connection interfaces

Parameters

value ORed combination of RotatorConnection values.

◆ updateProperties() [1/2]

bool Rotator::updateProperties ( )

virtual

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.

Reimplemented in Pyxis.

◆ updateProperties() [2/2]

virtual bool INDI::Rotator::updateProperties ( )

virtual

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.

Reimplemented in Pyxis.

Member Data Documentation

◆ PortFD

int Rotator::PortFD = -1

protected

◆ PresetGotoS

ISwitch Rotator::PresetGotoS

protected

◆ PresetGotoSP

ISwitchVectorProperty Rotator::PresetGotoSP

protected

◆ PresetN

INumber Rotator::PresetN

protected

◆ PresetNP

INumberVectorProperty Rotator::PresetNP

protected

◆ RotatorConnection [1/2]

enum { ... } INDI::Rotator::RotatorConnection

◆ RotatorConnection [2/2]

enum { ... } INDI::Rotator::RotatorConnection

◆ rotatorConnection

uint8_t Rotator::rotatorConnection = CONNECTION_SERIAL | CONNECTION_TCP

private

◆ serialConnection

Connection::Serial * Rotator::serialConnection = NULL

protected

◆ tcpConnection

Connection::TCP * Rotator::tcpConnection = NULL

protected

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

/home/nirva/insroot/include/libindi/indirotator.h
ln/3rdparty/src/indilib/indi-1.7.4/libindi/libs/indibase/indirotator.cpp

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ Rotator() [1/2]

◆ ~Rotator() [1/2]

◆ Rotator() [2/2]

◆ ~Rotator() [2/2]

Member Function Documentation

◆ callHandshake() [1/2]

◆ callHandshake() [2/2]

◆ getRotatorConnection() [1/2]

◆ getRotatorConnection() [2/2]

◆ Handshake() [1/2]

◆ Handshake() [2/2]

◆ initProperties() [1/2]

◆ initProperties() [2/2]

◆ ISGetProperties() [1/2]

◆ ISGetProperties() [2/2]

◆ ISNewNumber() [1/2]

◆ ISNewNumber() [2/2]

◆ ISNewSwitch() [1/2]

◆ ISNewSwitch() [2/2]

◆ saveConfigItems() [1/2]

◆ saveConfigItems() [2/2]

◆ setRotatorConnection() [1/2]

◆ setRotatorConnection() [2/2]

◆ updateProperties() [1/2]

◆ updateProperties() [2/2]

Member Data Documentation

◆ PortFD

◆ PresetGotoS

◆ PresetGotoSP

◆ PresetN

◆ PresetNP

◆ RotatorConnection [1/2]

◆ RotatorConnection [2/2]

◆ rotatorConnection

◆ serialConnection

◆ tcpConnection