INDI::BaseClientQt Class Reference

Class to provide basic client functionality based on Qt5 toolkit and is therefore suitable for cross-platform development. More...

#include <baseclientqt.h>

Inheritance diagram for INDI::BaseClientQt:

Public Member Functions
	BaseClientQt (QObject *parent=Q_NULLPTR)
virtual	~BaseClientQt ()
bool	connectServer () override
	Connect to INDI server.
bool	disconnectServer (int exit_code=0) override
	Disconnect from INDI server. Any devices previously created will be deleted and memory cleared.
Public Member Functions inherited from INDI::AbstractBaseClient
	AbstractBaseClient ()=delete
virtual	~AbstractBaseClient ()
void	setServer (const char *hostname, unsigned int port)
	Set the server host name and port.
const char *	getHost () const
	Get the server host name.
int	getPort () const
	Get the port number.
bool	isServerConnected () const
	Get status of the connection.
void	setConnectionTimeout (uint32_t seconds, uint32_t microseconds)
	setConnectionTimeout Set connection timeout. By default it is 3 seconds.
void	setVerbose (bool enable)
	setVerbose Set verbose mode
bool	isVerbose () const
	isVerbose Is client in verbose mode?
void	watchDevice (const char *deviceName)
	Add a device to the watch list.
void	watchDevice (const char *deviceName, const std::function< void(BaseDevice)> &callback)
void	watchProperty (const char *deviceName, const char *propertyName)
	watchProperties Add a property to the watch list. When communicating with INDI server.
void	connectDevice (const char *deviceName)
	Disconnect INDI driver.
void	disconnectDevice (const char *deviceName)
	Disconnect INDI driver.
INDI::BaseDevice	getDevice (const char *deviceName)
std::vector< INDI::BaseDevice >	getDevices () const
bool	getDevices (std::vector< INDI::BaseDevice > &deviceList, uint16_t driverInterface)
	getDevices Returns list of devices that belong to a particular DRIVER_INTERFACE class.
void	setBLOBMode (BLOBHandling blobH, const char *dev, const char *prop=nullptr)
	Set Binary Large Object policy mode.
BLOBHandling	getBLOBMode (const char *dev, const char *prop=nullptr)
	getBLOBMode Get Binary Large Object policy mode IF set previously by setBLOBMode
void	sendNewProperty (INDI::Property pp)
	Send new Property command to server.
void	sendNewText (INDI::Property pp)
	Send new Text command to server.
void	sendNewText (const char *deviceName, const char *propertyName, const char *elementName, const char *text)
	Send new Text command to server.
void	sendNewNumber (INDI::Property pp)
	Send new Number command to server.
void	sendNewNumber (const char *deviceName, const char *propertyName, const char *elementName, double value)
	Send new Number command to server.
void	sendNewSwitch (INDI::Property pp)
	Send new Switch command to server.
void	sendNewSwitch (const char *deviceName, const char *propertyName, const char *elementName)
	Send new Switch command to server.
void	startBlob (const char *devName, const char *propName, const char *timestamp)
	Send opening tag for BLOB command to server.
void	sendOneBlob (IBLOB *bp)
	Send ONE blob content to server. The BLOB data in raw binary format and will be converted to base64 and sent to server.
void	sendOneBlob (INDI::WidgetViewBlob *blob)
void	sendOneBlob (const char *blobName, unsigned int blobSize, const char *blobFormat, void *blobBuffer)
	Send ONE blob content to server. The BLOB data in raw binary format and will be converted to base64 and sent to server.
void	finishBlob ()
	Send closing tag for BLOB command to server.
void	sendPingRequest (const char *uid)
	Send one ping request, the server will answer back with the same uuid.
void	sendPingReply (const char *uid)
	Send a ping reply for the given uuid.
Public Member Functions inherited from INDI::BaseMediator
virtual	~BaseMediator ()=default
virtual void	newDevice (INDI::BaseDevice baseDevice)
	Emmited when a new device is created from INDI server.
virtual void	removeDevice (INDI::BaseDevice baseDevice)
	Emmited when a device is deleted from INDI server.
virtual void	newProperty (INDI::Property property)
	Emmited when a new property is created for an INDI driver.
virtual void	updateProperty (INDI::Property property)
	Emmited when a new property value arrives from INDI server.
virtual void	removeProperty (INDI::Property property)
	Emmited when a property is deleted for an INDI driver.
virtual void	newMessage (INDI::BaseDevice baseDevice, int messageID)
	Emmited when a new message arrives from INDI server.
virtual void	serverConnected ()
	Emmited when the server is connected.
virtual void	serverDisconnected (int exit_code)
	Emmited when the server gets disconnected.
virtual void	newDevice (INDI::BaseDevice *dp)
	Emmited when a new device is created from INDI server.
virtual void	removeDevice (INDI::BaseDevice *dp)
	Emmited when a device is deleted from INDI server.
virtual void	newProperty (INDI::Property *property)
	Emmited when a new property is created for an INDI driver.
virtual void	removeProperty (INDI::Property *property)
	Emmited when a property is deleted for an INDI driver.
virtual void	newSwitch (ISwitchVectorProperty *svp)
	Emmited when a new switch value arrives from INDI server.
virtual void	newNumber (INumberVectorProperty *nvp)
	Emmited when a new number value arrives from INDI server.
virtual void	newText (ITextVectorProperty *tvp)
	Emmited when a new text value arrives from INDI server.
virtual void	newLight (ILightVectorProperty *lvp)
	Emmited when a new light value arrives from INDI server.
virtual void	newBLOB (IBLOB *bp)
	Emmited when a new property value arrives from INDI server.
virtual void	newMessage (INDI::BaseDevice *dp, int messageID)
	Emmited when a new message arrives from INDI server.

Additional Inherited Members
Protected Member Functions inherited from INDI::AbstractBaseClient
virtual void	newPingReply (std::string uid)
	pingReply are sent by the server on response to pingReply (see above).
virtual void	newUniversalMessage (std::string message)
	newUniversalMessage Universal messages are sent from INDI server without a specific device. It is addressed to the client overall.
	AbstractBaseClient (std::unique_ptr< AbstractBaseClientPrivate > &&dd)
Protected Attributes inherited from INDI::AbstractBaseClient
std::unique_ptr< AbstractBaseClientPrivate >	d_ptr_indi

Detailed Description

Class to provide basic client functionality based on Qt5 toolkit and is therefore suitable for cross-platform development.

BaseClientQt enables accelerated development of INDI Clients by providing a framework that facilitates communication, device handling, and event notification. By subclassing BaseClientQt, clients can quickly connect to an INDI server, and query for a set of INDI::BaseDevice devices, and read and write properties seamlessly. Event driven programming is possible due to notifications upon reception of new devices or properties.

Attention

All notifications functions defined in INDI::BaseMediator must be implemented in the client class even if they are not used because these are pure virtual functions.

See also

INDI Client Tutorial for more details.

Author

Jasem Mutlaq

Definition at line 47 of file baseclientqt.h.

Constructor & Destructor Documentation

BaseClientQt()

INDI::BaseClientQt::BaseClientQt

(

QObject *

parent = Q_NULLPTR

)

Definition at line 87 of file baseclientqt.cpp.

~BaseClientQt()

INDI::BaseClientQt::~BaseClientQt ( )

virtual

Definition at line 117 of file baseclientqt.cpp.

Member Function Documentation

connectServer()

bool INDI::BaseClientQt::connectServer ( )

overridevirtual

Connect to INDI server.

Returns

True if the connection is successful, false otherwise.

Note

This function blocks until connection is either successfull or unsuccessful.

Implements INDI::AbstractBaseClient.

Definition at line 123 of file baseclientqt.cpp.

disconnectServer()

bool INDI::BaseClientQt::disconnectServer ( int  exit_code = 0 )

overridevirtual

Disconnect from INDI server. Any devices previously created will be deleted and memory cleared.

Returns

True if disconnection is successful, false otherwise.

Implements INDI::AbstractBaseClient.

Definition at line 145 of file baseclientqt.cpp.

---

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

• baseclientqt.h
• baseclientqt.cpp