summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJasem Mutlaq <[email protected]>2015-07-06 22:15:29 +0300
committerJasem Mutlaq <[email protected]>2015-07-06 22:15:29 +0300
commitfa915c99db6dabf8d06e4567b338e9f4eacf65e4 (patch)
treebd7f0deb494638b484451c792df5d542ab50ca7e
parent5fe737385aa6f47cea60871653eced6588f317d5 (diff)
Update DBus documentation
-rw-r--r--Mainpage.dox4
-rw-r--r--kstars/ekos/capture.h7
-rw-r--r--kstars/ekos/ekosmanager.h22
-rw-r--r--kstars/ekos/mount.h10
4 files changed, 34 insertions, 9 deletions
diff --git a/Mainpage.dox b/Mainpage.dox
index 54b885a..581a351 100644
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -93,7 +93,9 @@ The "model" is encapsulated in the KStarsData class, and the "view" is encapsula
- \ref KSNotify "Notifications"
\subsection Scripting Scripting
- - \ref DBusInterface DBus Interface
+ - \ref DBusInterface KStars DBus Interface
+ - \ref INDIDBusInterface INDI DBus Interface: Provides low level access to all INDI devices and properties.
+ - \ref EkosDBusInterface Ekos DBus Interface: Provides high level access to \ref EkosManager and corresponding modules.
- \ref ScriptBuilder Script builder
\section HowItWorks How does it work?
diff --git a/kstars/ekos/capture.h b/kstars/ekos/capture.h
index df7b406..ae0313e 100644
--- a/kstars/ekos/capture.h
+++ b/kstars/ekos/capture.h
@@ -43,13 +43,18 @@ class KDirWatch;
* - Auto guiding with support for automatic dithering between exposures and support for Adaptive Optics devices in addition to traditional guiders.
* - Powerful sequence queue for batch capture of images with optional prefixes, timestamps, filter wheel selection, and much more!
* - Export and import sequence queue sets as Ekos Sequence Queue (.esq) files.
+ * - Center the telescope anywhere in a captured FITS image or any FITS with World Coordinate System (WCS) header.
+ * - Automatic flat field capture, just set the desired ADU and let Ekos does the rest!
* - Automatic abort and resumption of exposure tasks if guiding errors exceed a user-configurable value.
* - Support for dome slaving.
* - Complete integration with KStars Observation Planner and SkyMap
* - Integrate with all INDI native devices.
* - Powerful scripting capabilities via \ref EkosDBusInterface "DBus."
+ *
+ * The primary class is EkosManager. It handles startup and shutdown of local and remote INDI devices, manages and orchesterates the various Ekos modules, and provides advanced DBus
+ * interface to enable unattended scripting.
*@author Jasem Mutlaq
- *@version 1.0
+ *@version 1.1
*/
namespace Ekos
{
diff --git a/kstars/ekos/ekosmanager.h b/kstars/ekos/ekosmanager.h
index 1ff53e5..39e2bd0 100644
--- a/kstars/ekos/ekosmanager.h
+++ b/kstars/ekos/ekosmanager.h
@@ -32,9 +32,18 @@ class KPageWidgetItem;
/**
*@class EkosManager
*@short Primary class to handle all Ekos modules.
- * The Ekos Manager class manages startup and shutdown of INDI devices and registeration of devices within Ekos Modules. Ekos module consist of Capture, Focus, Guide, and Align modules.
+ * The Ekos Manager class manages startup and shutdown of INDI devices and registeration of devices within Ekos Modules. Ekos module consist of \ref Ekos::Mount, \ref Ekos::Capture, \ref Ekos::Focus, \ref Ekos::Guide, and \ref Ekos::Align modules.
+ * \ref EkosDBusInterface "Ekos DBus Interface" provides high level functions to control devices and Ekos modules for a total robotic operation:
+ * <ul>
+ * <li>\ref CaptureDBusInterface "Capture Module DBus Interface"</li>
+ * <li>\ref FocusDBusInterface "Focus Module DBus Interface"</li>
+ * <li>\ref MountDBusInterface "Mount Module DBus Interface"</li>
+ * <li>\ref GuideDBusInterface "Guide Module DBus Interface"</li>
+ * <li>\ref AlignDBusInterface "Align Module DBus Interface"</li>
+ * </ul>
+ * For low level access to INDI devices, the \ref INDIDBusInterface "INDI Dbus Interface" provides complete access to INDI devices and properties.
*@author Jasem Mutlaq
- *@version 1.0
+ *@version 1.1
*/
class EkosManager : public QDialog, public Ui::EkosManager
{
@@ -132,12 +141,9 @@ public:
* @param index 1 for Aux 1, 2 for Aux 2, 3 for Aux 3
* @param auxiliaryName auxiliary driver name. For remote devices, the name has to be exactly as the name defined by the driver on startup.
*/
- Q_SCRIPTABLE Q_NOREPLY void setAuxiliary(int index, const QString & auxiliaryName);
-
- /** @}*/
+ Q_SCRIPTABLE Q_NOREPLY void setAuxiliary(int index, const QString & auxiliaryName);
public slots:
- void processINDI();
/** DBUS interface function.
* Connects all the INDI devices started by Ekos.
@@ -148,6 +154,10 @@ public slots:
* Disconnects all the INDI devices started by Ekos.
*/
Q_SCRIPTABLE Q_NOREPLY void disconnectDevices();
+
+ /** @}*/
+
+ void processINDI();
void cleanDevices();
void processNewDevice(ISD::GDInterface*);
diff --git a/kstars/ekos/mount.h b/kstars/ekos/mount.h
index 25ef2ad..674e1a9 100644
--- a/kstars/ekos/mount.h
+++ b/kstars/ekos/mount.h
@@ -22,7 +22,7 @@ namespace Ekos
/**
*@class Mount
- *@short Supports Control INDI telescopes and displays information about them.
+ *@short Supports controlling INDI telescope devices including setting/retrieving mount properties, slewing, motion and speed controls, in addition to enforcing altitude limits and parking/unparking.
*@author Jasem Mutlaq
*@version 1.1
*/
@@ -47,6 +47,12 @@ public:
void clearLog();
QString getLogText() { return logText.join("\n"); }
+ /** @defgroup MountDBusInterface Ekos Mount DBus Interface
+ * Mount interface provides advanced scripting capabilities to control INDI mounts.
+ */
+
+ /*@{*/
+
/** DBUS interface function.
* Returns the mount altitude limits.
* @return Returns array of doubles. First item is minimum altititde in degrees. Second item is maximum altitude limit in degrees.
@@ -103,6 +109,8 @@ public:
*/
Q_SCRIPTABLE Q_NOREPLY void setTelescopeInfo(double primaryFocalLength, double primaryAperture, double guideFocalLength, double guideAperture);
+ /** @}*/
+
public slots:
/**