INDIDBus

#include <indidbus.h>

Inheritance diagram for INDIDBus:

Public Member Functions
	INDIDBus (QObject *parent=nullptr)

Q_SCRIPTABLE bool	connect (const QString &host, int port)

Q_SCRIPTABLE bool	disconnect (const QString &host, int port)

Q_SCRIPTABLE QByteArray	getBLOBData (const QString &device, const QString &property, const QString &blobName, QString &blobFormat, int &size)

Q_SCRIPTABLE QString	getBLOBFile (const QString &device, const QString &property, const QString &blobName, QString &blobFormat, int &size)

Q_SCRIPTABLE QStringList	getDevices ()

Q_SCRIPTABLE QStringList	getDevicesPaths (uint32_t interface)

Q_SCRIPTABLE QString	getLight (const QString &device, const QString &property, const QString &lightName)

Q_SCRIPTABLE double	getNumber (const QString &device, const QString &property, const QString &numberName)

Q_SCRIPTABLE QStringList	getProperties (const QString &device)

Q_SCRIPTABLE QString	getPropertyState (const QString &device, const QString &property)

Q_SCRIPTABLE QString	getSwitch (const QString &device, const QString &property, const QString &switchName)

Q_SCRIPTABLE QString	getText (const QString &device, const QString &property, const QString &textName)

Q_SCRIPTABLE bool	sendProperty (const QString &device, const QString &property)

Q_SCRIPTABLE bool	setNumber (const QString &device, const QString &property, const QString &numberName, double value)

Q_SCRIPTABLE bool	setSwitch (const QString &device, const QString &property, const QString &switchName, const QString &status)

Q_SCRIPTABLE bool	setText (const QString &device, const QString &property, const QString &textName, const QString &text)

Q_SCRIPTABLE bool	start (int port, const QStringList &drivers)

Q_SCRIPTABLE bool	stop (const QString &port)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Collection of INDI DBus functions.

Author: Jasem Mutlaq

Definition at line 18 of file indidbus.h.

Constructor & Destructor Documentation

◆ INDIDBus()

INDIDBus::INDIDBus ( QObject * parent = nullptr )

explicit

Definition at line 22 of file indidbus.cpp.

Member Function Documentation

◆ connect()

bool INDIDBus::connect	(	const QString &	host,
		int	port )

DBUS interface function.

Connect to an INDI server

Parameters

host	hostname of server to connect to.
port	Port of server.

Definition at line 77 of file indidbus.cpp.

◆ disconnect()

bool INDIDBus::disconnect	(	const QString &	host,
		int	port )

DBUS interface function.

Disconnect from an INDI server

Parameters

host	hostname of server to disconnect.
port	Port of server.

Definition at line 98 of file indidbus.cpp.

◆ getBLOBData()

QByteArray INDIDBus::getBLOBData	(	const QString &	device,
		const QString &	property,
		const QString &	blobName,
		QString &	blobFormat,
		int &	size )

DBUS interface function.

Returns INDI blob data. It can be extremely inefficient transporting large amount of data via DBUS.

Parameters

device	device name
property	property name
blobName	blob element name
blobFormat	blob element format. It is usually the extension of the blob file.
size	blob element size in bytes. If -1, then there is an error.

Returns: array of bytes containing blob.

See also: getBLOBFile

Definition at line 488 of file indidbus.cpp.

◆ getBLOBFile()

QString INDIDBus::getBLOBFile	(	const QString &	device,
		const QString &	property,
		const QString &	blobName,
		QString &	blobFormat,
		int &	size )

DBUS interface function.

Returns INDI blob filename stored on the local file system.

Parameters

device	device name
property	property name
blobName	blob element name
blobFormat	blob element format. It is usually the extension of a file.
size	blob element size in bytes. If -1, then there is an error.

Returns: full file name

Definition at line 525 of file indidbus.cpp.

◆ getDevices()

QStringList INDIDBus::getDevices ( )

DBUS interface function.

Returns a list of INDI devices

Returns: List of device names

Definition at line 117 of file indidbus.cpp.

◆ getDevicesPaths()

QStringList INDIDBus::getDevicesPaths ( uint32_t interface )

DBUS interface function.

Returns a list of INDI devices

Returns: List of device names

Definition at line 129 of file indidbus.cpp.

◆ getLight()

QString INDIDBus::getLight	(	const QString &	device,
		const QString &	property,
		const QString &	lightName )

DBUS interface function.

Returns INDI Light state

Parameters

device	device name
property	name
lightName	light element name

Returns: Idle, Ok, Busy, or Alert. If no property is found, it returns "Invalid"

Definition at line 262 of file indidbus.cpp.

◆ getNumber()

double INDIDBus::getNumber	(	const QString &	device,
		const QString &	property,
		const QString &	numberName )

DBUS interface function.

Returns INDI number value

Parameters

device	device name
property	name
numberName	number element name

Returns: number value. If no text is found, it returns NAN.

Definition at line 457 of file indidbus.cpp.

◆ getProperties()

QStringList INDIDBus::getProperties ( const QString & device )

DBUS interface function.

Returns a list of INDI properties

Parameters

device device name

Returns: List of properties in the format DEVICE.PROPERTY.ELEMENT.

Definition at line 141 of file indidbus.cpp.

◆ getPropertyState()

QString INDIDBus::getPropertyState	(	const QString &	device,
		const QString &	property )

DBUS interface function.

Returns INDI property state

Parameters

device	device name
property	property name

Returns: Idle, Ok, Busy, or Alert. If no property is found, it returns "Invalid"

Definition at line 193 of file indidbus.cpp.

◆ getSwitch()

QString INDIDBus::getSwitch	(	const QString &	device,
		const QString &	property,
		const QString &	switchName )

DBUS interface function.

Returns INDI switch status

Parameters

device	device name
property	property name
switchName	switch name

Returns: On or Off if switch is found. If no switch is found, it returns "Invalid".

Definition at line 335 of file indidbus.cpp.

◆ getText()

QString INDIDBus::getText	(	const QString &	device,
		const QString &	property,
		const QString &	textName )

DBUS interface function.

Returns INDI text value

Parameters

device	device name
property	property name
textName	text element name

Returns: text value. If no text is found, it returns "Invalid".

Definition at line 396 of file indidbus.cpp.

◆ sendProperty()

bool INDIDBus::sendProperty	(	const QString &	device,
		const QString &	property )

DBUS interface function.

Sends property to INDI server

Parameters

device	device name
property	property name

Returns: true if property is found and sent to server, false otherwise.

Definition at line 217 of file indidbus.cpp.

◆ setNumber()

bool INDIDBus::setNumber	(	const QString &	device,
		const QString &	property,
		const QString &	numberName,
		double	value )

DBUS interface function.

Set INDI Number

Parameters

device	device name
property	property name
numberName	number element name
value	number value

Returns: true if successful, false otherwise. /note This function ONLY sets the number value but does not send it to server. Use sendProperty to send a number to server.

Definition at line 427 of file indidbus.cpp.

◆ setSwitch()

bool INDIDBus::setSwitch	(	const QString &	device,
		const QString &	property,
		const QString &	switchName,
		const QString &	status )

DBUS interface function.

Set INDI Switch status

Parameters

device	device name
property	property name
switchName	switch name
status	Either On or Off. /note This function ONLY sets the switch status but does not send it to server. Use sendProperty to send a switch to server.

Definition at line 294 of file indidbus.cpp.

◆ setText()

bool INDIDBus::setText	(	const QString &	device,
		const QString &	property,
		const QString &	textName,
		const QString &	text )

DBUS interface function.

Set INDI Text

Parameters

device	device name
property	property name
textName	text element name
text	text value /note This function ONLY sets the text value but does not send it to server. Use sendProperty to send a text to server.

Definition at line 366 of file indidbus.cpp.

◆ start()

bool INDIDBus::start	(	int	port,
		const QStringList &	drivers )

DBUS interface function.

Start a local INDI server given a list of drivers on the given port.

Parameters

port	Port used to establish server. If empty, default port 7624 is used.
drivers	List of drivers executables to run.

Definition at line 28 of file indidbus.cpp.

◆ stop()

bool INDIDBus::stop ( const QString & port )

DBUS interface function.

Stops server running on the given port

Parameters

port	Port of existing server to stop

Definition at line 53 of file indidbus.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kstars

INDIDBus

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ INDIDBus()

Member Function Documentation

◆ connect()

◆ disconnect()

◆ getBLOBData()

◆ getBLOBFile()

◆ getDevices()

◆ getDevicesPaths()

◆ getLight()

◆ getNumber()

◆ getProperties()

◆ getPropertyState()

◆ getSwitch()

◆ getText()

◆ sendProperty()

◆ setNumber()

◆ setSwitch()

◆ setText()

◆ start()

◆ stop()