[kstars] doc: Add Ekos docs to KStars
Yuri Chornoivan
null at kde.org
Fri Jan 18 15:08:42 GMT 2019
Git commit 2fb6d94b091cbdefdf5674db80bd478ffc07111c by Yuri Chornoivan.
Committed on 18/01/2019 at 15:08.
Pushed by yurchor into branch 'master'.
Add Ekos docs to KStars
Summary: Ekos docs by Jasem Mutlaq (converted by his permission), screenshots and video from the StellarMate site.
Test Plan: checkXML5, meinproc5, and PDF conversion works fine.
Reviewers: #documentation, #kstars, mutlaqja
Reviewed By: #kstars, mutlaqja
Subscribers: kde-edu, kde-doc-english
Tags: #kde_edu, #documentation
Differential Revision: https://phabricator.kde.org/D18335
A +- -- doc/add-circle.png
A +- -- doc/alignment_polaris.png
A +- -- doc/astrometry_indexes_settings.png
A +- -- doc/astrometry_settings.png
A +- -- doc/astrometry_windows_ansvr.png
A +- -- doc/calibration_settings.png
A +- -- doc/capture_settings.png
M +1 -1 doc/commands.docbook
M +2 -2 doc/config.docbook
A +- -- doc/dark_library.png
A +- -- doc/dialog-ok-apply.png
A +- -- doc/document-edit.png
A +- -- doc/document-open.png
A +724 -0 doc/ekos-align.docbook
A +558 -0 doc/ekos-capture.docbook
A +314 -0 doc/ekos-fits-viewer.docbook
A +253 -0 doc/ekos-focus.docbook
A +337 -0 doc/ekos-guide.docbook
A +24 -0 doc/ekos-logs.docbook
A +82 -0 doc/ekos-profile-editor.docbook
A +123 -0 doc/ekos-profile-wizard.docbook
A +344 -0 doc/ekos-scheduler.docbook
A +40 -0 doc/ekos-setup.docbook
A +26 -0 doc/ekos-tutorials.docbook
A +119 -0 doc/ekos-user-interface.docbook
A +143 -0 doc/ekos.docbook
A +- -- doc/ekos_astrometry.png
A +- -- doc/ekos_capture.png
A +- -- doc/ekos_focus.png
A +- -- doc/ekos_guide.png
A +- -- doc/ekos_guide_phd2.png
A +- -- doc/ekos_profile_guider_select.png
A +- -- doc/ekos_remote_astrometry.png
A +- -- doc/ekos_rotator_settings.png
A +- -- doc/ekos_scheduler.png
A +- -- doc/ekos_summary.png
A +- -- doc/ekos_summary_cheatsheet.png
A +- -- doc/file_settings.png
A +- -- doc/filter_settings.png
A +- -- doc/fits_settings.png
A +- -- doc/fitsviewer_embedded.png
A +- -- doc/fitsviewer_histogram.png
A +- -- doc/focus_ccdfw_group.png
A +- -- doc/focus_relative_profile.png
A +- -- doc/focus_settings.png
A +- -- doc/focus_vcurve.png
A +- -- doc/focuser_group.png
A +- -- doc/guide_calibration_settings.png
A +- -- doc/guide_drift_graphics.png
A +- -- doc/guide_guide_settings.png
M +22 -9 doc/index.docbook
A +- -- doc/kstars_annotation.png
A +- -- doc/kstars_m44_mac.png
A +- -- doc/limit_settings.png
A +- -- doc/list-add.png
A +- -- doc/media-playback-pause.png
A +- -- doc/media-playback-start.png
A +- -- doc/mosaic_wizard.png
A +- -- doc/polar_alignment_result.png
A +- -- doc/polar_assistant_main.png
A +- -- doc/profile_editor.png
A +- -- doc/profile_wizard_done.png
A +- -- doc/profile_wizard_remote.png
A +- -- doc/profile_wizard_select.png
A +- -- doc/profile_wizard_welcome.png
A +- -- doc/scheduler_planner.png
A +- -- doc/security-high.png
A +- -- doc/security-low.png
A +- -- doc/security-medium.png
A +- -- doc/sequence_settings.png
A +- -- doc/solver_settings.png
A +- -- doc/star_profile_examine_pixels.png
A +- -- doc/star_profile_final.png
A +- -- doc/star_profile_main.png
A +- -- doc/star_profile_toolbar1.png
A +- -- doc/star_profile_toolbar2.png
A +- -- doc/star_profile_vertical.png
M +2 -0 doc/tools.docbook
A +- -- doc/view-filter.png
A +- -- doc/view-fullscreen.png
A +- -- doc/view-refresh.png
https://commits.kde.org/kstars/2fb6d94b091cbdefdf5674db80bd478ffc07111c
diff --git a/doc/add-circle.png b/doc/add-circle.png
new file mode 100644
index 000000000..0d35cd7b7
Binary files /dev/null and b/doc/add-circle.png differ
diff --git a/doc/alignment_polaris.png b/doc/alignment_polaris.png
new file mode 100644
index 000000000..946965827
Binary files /dev/null and b/doc/alignment_polaris.png differ
diff --git a/doc/astrometry_indexes_settings.png b/doc/astrometry_indexes_settings.png
new file mode 100644
index 000000000..3f0cdccf6
Binary files /dev/null and b/doc/astrometry_indexes_settings.png differ
diff --git a/doc/astrometry_settings.png b/doc/astrometry_settings.png
new file mode 100644
index 000000000..fa3268778
Binary files /dev/null and b/doc/astrometry_settings.png differ
diff --git a/doc/astrometry_windows_ansvr.png b/doc/astrometry_windows_ansvr.png
new file mode 100644
index 000000000..a6136c8bd
Binary files /dev/null and b/doc/astrometry_windows_ansvr.png differ
diff --git a/doc/calibration_settings.png b/doc/calibration_settings.png
new file mode 100644
index 000000000..7a60b5a83
Binary files /dev/null and b/doc/calibration_settings.png differ
diff --git a/doc/capture_settings.png b/doc/capture_settings.png
new file mode 100644
index 000000000..bc21a807c
Binary files /dev/null and b/doc/capture_settings.png differ
diff --git a/doc/commands.docbook b/doc/commands.docbook
index 4b7f6c0a7..037d8862e 100644
--- a/doc/commands.docbook
+++ b/doc/commands.docbook
@@ -563,7 +563,7 @@ current simulation date.
</menuchoice></term>
<listitem>
<para>
-Opens <guilabel>Ekos</guilabel>, a complete and powerful tool for astrophotography.
+Opens <link linkend="tool-ekos">Ekos</link>, a complete and powerful tool for astrophotography.
With Ekos, you can align and guide your telescope, focus your CCD, and capture
images using an easy intuitive interface.
</para>
diff --git a/doc/config.docbook b/doc/config.docbook
index 541f907cf..6f00f54b8 100644
--- a/doc/config.docbook
+++ b/doc/config.docbook
@@ -200,7 +200,7 @@ page see the <link linkend="indi-configure">Configure INDI</link> section.
</para>
<para>For detailed explanation of <guilabel>Ekos</guilabel> astrophotography suite,
-see the official <ulink url="http://www.indilib.org/about/ekos.html">Ekos</ulink> page.
+see the <link linkend="tool-ekos">Ekos section of this manual</link>.
</para>
<para>
@@ -1045,7 +1045,7 @@ all INDI devices including numerous telescopes, CCDs, DSLRs, focusers, filters,
Ekos supports highly accurate tracking using online and offline astrometry solver, autofocus
and autoguiding capabilities, and capture of single or multiple images using the powerful
built in sequence manager. For detailed explanation of <guilabel>Ekos</guilabel>,
-see the official <ulink url="http://www.indilib.org/about/ekos.html">Ekos</ulink> page.
+see the <link linkend="tool-ekos">Ekos section of this manual</link>.
</para>
</sect1>
diff --git a/doc/dark_library.png b/doc/dark_library.png
new file mode 100644
index 000000000..d0d58b3aa
Binary files /dev/null and b/doc/dark_library.png differ
diff --git a/doc/dialog-ok-apply.png b/doc/dialog-ok-apply.png
new file mode 100644
index 000000000..f1936122b
Binary files /dev/null and b/doc/dialog-ok-apply.png differ
diff --git a/doc/document-edit.png b/doc/document-edit.png
new file mode 100644
index 000000000..4faac6f4d
Binary files /dev/null and b/doc/document-edit.png differ
diff --git a/doc/document-open.png b/doc/document-open.png
new file mode 100644
index 000000000..edf5baa22
Binary files /dev/null and b/doc/document-open.png differ
diff --git a/doc/ekos-align.docbook b/doc/ekos-align.docbook
new file mode 100644
index 000000000..8b63d7ce3
--- /dev/null
+++ b/doc/ekos-align.docbook
@@ -0,0 +1,724 @@
+<sect2 id="ekos-align">
+ <title>Align</title>
+ <indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Align</tertiary>
+ </indexterm>
+ <sect3 id="ekos-align-introduction">
+ <title>Introduction</title>
+ <screenshot>
+ <screeninfo>
+ Ekos Align Module
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_astrometry.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos Align Module</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Ekos Alignment Module enables highly accurate GOTOs to within sub-arcseconds accuracy and can measure and correct polar alignment errors. This is possible thanks to the astrometry.net solver. Ekos begins by capturing an image of a star field, feeding that image to <ulink url="http://www.astrometry.net">astrometry.net</ulink> solver, and getting the central coordinates (RA, DEC) of the image. The solver essentially performs a pattern recognition against a catalog of millions of stars. Once the coordinates are determined, the true pointing of the telescope is known.
+ </para>
+ <para>
+ Often, there is a discrepancy between where the telescope thinks it is looking at and where it is truly pointing. The magnitude of this discrepancy can range from a few arcminutes to a couple of degrees. Ekos can then correct the discrepancy by either syncing to the new coordinates, or by slewing the mount to the desired target originally requested.
+ </para>
+ <para>
+ Furthermore, Ekos provides two tools to measure and correct polar alignment errors:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Polar Alignment Assistant Tool</guilabel>: A very easy tool to measure and correct polar errors. It takes three images near the celestial pole (Close to Polaris for Northern Hemisphere) and then calculates the offset between the mount axis and polar axis.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Legacy Polar Alignment Tool</guilabel>: If Polaris is not visible, this tool can be used to measure and correct polar alignment errors. It captures a couple of images near the meridian and east/west of the meridian. This will enable the user to adjust the mount until the misalignment is minimized.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ At a minimum, you need a CCD/Webcam and a telescope that supports Slew & Sync commands. Most popular commercial telescope nowadays support such commands.
+ </para>
+ <para>
+ For the Ekos Alignment Module to work, you have an option of either utilizing the <emphasis>online</emphasis> astrometry.net solver, <emphasis>offline</emphasis>, or <emphasis>remote</emphasis> solver
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Online Solver</guilabel>: The online solver requires no configuration, and depending on your Internet bandwidth, it might take a while to upload and solve the image.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Offline Solver</guilabel>: The offline solver can be faster and requires no Internet connection. In order to use the offline solver, you must install astrometry.net in addition to the necessary index files.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Remote Solver</guilabel>: The remote solver is an offline solver the resides on a different machine (for example, you can use Astrometry solver on StellarMate). Captured images are solved on the remote machine.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="ekos-align-get-astrometry">
+ <title>Get astrometry.net</title>
+
+ <para>
+ If you are planning to use <emphasis>Offline</emphasis> astrometry then you need to download astrometry.net application.
+ </para>
+ <note>
+ <para>
+ Astrometry.net is already shipped with StellarMate so there is no need to install it. Index files from 16 arcminutes and above (4206 to 4019) are included with StellarMate. For any additional index files, you need to install them as necessary. To use Astrometry in StellarMate from a remote Ekos on &Linux;/&Windows;/&MacOS;, make sure to select <guimenuitem>Remote</guimenuitem> option in Ekos Alignment Module. Furthermore, make sure that the <guimenuitem>Astrometry</guimenuitem> driver is selected in your equipment profile.
+ </para>
+ </note>
+ <screenshot>
+ <screeninfo>
+ Ekos Remote Astrometry
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_remote_astrometry.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos Remote Astrometry</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <variablelist>
+ <varlistentry>
+ <term>&Windows;</term>
+ <listitem>
+ <para>
+ To use astrometry.net under Windows, you need to download and install the <ulink url="http://adgsoftware.com/ansvr/">ANSVR Local Astrometry.net solver</ulink>. The ANSVR mimics the astrometry.net online server on your local computer; thus the internet not required for any astrometry queries.
+ </para>
+ <para>
+ After installing the ANSVR server and downloading the appropriate index files for your setup, make sure ANSVR server is up and running and then go to Ekos Alignment options where you can simply change the <guilabel>API URL</guilabel> to use the ANSVR server as illustrated below:
+ </para>
+ <screenshot>
+ <screeninfo>
+ ANSVR Parameters
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="astrometry_windows_ansvr.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>ANSVR Parameters</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ In Ekos Align module, you must set the solver type to <guimenuitem>Online</guimenuitem> so that it uses the local ANSVR server for all astrometry queries. Then you can use the align module as you would normally do.
+ </para>
+ <para>
+ Remember as indicated above that StellarMate <emphasis>already</emphasis> includes astrometry.net. Therefore, if you would like to use StellarMate remotely to solve your images, simply change solver type to <guimenuitem>Remote</guimenuitem> and ensure that your equipment profile includes <emphasis role="bold">Astrometry</emphasis> driver which can be selected under the <guilabel>Auxiliary</guilabel> dropdown. This is applicable to all operating systems and not just Windows.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>&MacOS;</term>
+ <listitem>
+ <para>
+ Astrometry.net is already included with &kstars; for MacOS, so no need to install it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>&Linux;</term>
+ <listitem>
+ <para>
+ Astrometry.net is already included with &kstars; bleeding version. But if astrometry is not installed, then you can install it by running the following command under Ubuntu:
+ </para>
+ <para>
+ <command>sudo apt-get install astrometry.net</command>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="ekos-align-download-index-files">
+ <title>Download Index Files</title>
+ <para>
+ For offline (and remote) solvers, index files are necessary for the solver to work. The complete collection of index files is huge (over 30 GB), but you only need to download what is necessary for your equipment setup. Index files are sorted by the Field-Of-View (FOV) range they cover. There are two methods to fetch the necessary index files: The new download support in Align module, and the old manual way.
+ </para>
+ <sect4 id="ekos-align-automatic-download">
+ <title>Automatic Download</title>
+ <screenshot>
+ <screeninfo>
+ Astrometry.net Indexes Download
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="astrometry_indexes_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Astrometry.net Indexes Download</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Automatic download is only available for Ekos users on &Linux; & &MacOS;. For &Windows;; users, please download ANSVR solver.
+ </para>
+ <para>
+ To access the download page, click the <guibutton>Options</guibutton> button in the <link linkend="ekos-align">Align module</link> and then select <guilabel>Astrometry Index Files</guilabel> tab. The page displays the current FOV of your current setup and below it a list of available and installed index files. Three icons are used to designate the importance of index files given your current setup as follows:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <inlinemediaobject><imageobject><imagedata fileref="security-high.png" format="PNG"/></imageobject></inlinemediaobject> <guilabel>Required</guilabel>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <inlinemediaobject><imageobject><imagedata fileref="security-medium.png" format="PNG"/></imageobject></inlinemediaobject> <guilabel>Recommended</guilabel>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <inlinemediaobject><imageobject><imagedata fileref="security-low.png" format="PNG"/></imageobject></inlinemediaobject> <guilabel>Optional</guilabel>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ You must download all the required files, and if you have plenty of hard drive space left, you can also download the recommended indexes. If an index file is installed, the checkmark shall be checked, otherwise check it to download the relevant index file. Please only download one file at a time, especially for larger files. You might be prompted to enter the administrator password (default in StellarMate is <userinput>smate</userinput>) to install the files. Once you installed all the required files, you can begin using the offline astrometry.net solver immediately.
+ </para>
+ </sect4>
+ <sect4 id="ekos-align-manual-download">
+ <title>Manual Download</title>
+ <para>
+ You need to <ulink url="http://data.astrometry.net">download</ulink> and install the necessary index files suitable for your telescope+CCD field of view (FOV). You need to install index files covering 100% to 10% of your FOV. For example, if your FOV is 60 arcminutes, you need to install index files covering skymarks from 6 arcminutes (10%) to 60 arcminutes (100%). There are many online tools to calculate FOVs, such as <ulink url="http://starizona.com/acb/ccd/calc_pixel.aspx">Starizona Field of View Calculator.</ulink>
+ </para>
+ <table frame="all">
+ <title>Index Files</title>
+ <tgroup cols='3' align='left' colsep='1' rowsep='1'>
+ <thead>
+ <row>
+ <entry>Index Filename</entry>
+ <entry>FOV (arcminutes)</entry>
+ <entry>Debian Package</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>index-4219.fits</entry>
+ <entry>1400 - 2000</entry>
+ <entry morerows="11" valign="middle"><ulink url="http://data.astrometry.net/debian/astrometry-data-4208-4219_0.45_all.deb">astrometry-data-4208-4219</ulink></entry>
+ </row>
+ <row>
+ <entry>index-4218.fits</entry>
+ <entry>1000 - 1400</entry>
+ </row>
+ <row>
+ <entry>index-4217.fits</entry>
+ <entry>680 - 1000</entry>
+ </row>
+ <row>
+ <entry>index-4216.fits</entry>
+ <entry>480 - 680</entry>
+ </row>
+ <row>
+ <entry>index-4215.fits</entry>
+ <entry>340 - 480</entry>
+ </row>
+ <row>
+ <entry>index-4214.fits</entry>
+ <entry>240 - 340</entry>
+ </row>
+ <row>
+ <entry>index-4213.fits</entry>
+ <entry>170 - 240</entry>
+ </row>
+ <row>
+ <entry>index-4212.fits</entry>
+ <entry>120 - 170</entry>
+ </row>
+ <row>
+ <entry>index-4211.fits</entry>
+ <entry>85 - 120</entry>
+ </row>
+ <row>
+ <entry>index-4210.fits</entry>
+ <entry>60 - 85</entry>
+ </row>
+ <row>
+ <entry>index-4209.fits</entry>
+ <entry>42 - 60</entry>
+ </row>
+ <row>
+ <entry>index-4208.fits</entry>
+ <entry>30 - 42</entry>
+ </row>
+ <row>
+ <entry>index-4207-*.fits</entry>
+ <entry>22 - 30</entry>
+ <entry><ulink url="http://data.astrometry.net/debian/astrometry-data-4207_0.45_all.deb">astrometry-data-4207</ulink></entry>
+ </row>
+ <row>
+ <entry>index-4206-*.fits</entry>
+ <entry>16 - 22</entry>
+ <entry><ulink url="http://data.astrometry.net/debian/astrometry-data-4206_0.45_all.deb">astrometry-data-4206</ulink></entry>
+ </row>
+ <row>
+ <entry>index-4205-*.fits</entry>
+ <entry>11 - 16</entry>
+ <entry><ulink url="http://data.astrometry.net/debian/astrometry-data-4205_0.45_all.deb">astrometry-data-4205</ulink></entry>
+ </row>
+ <row>
+ <entry>index-4204-*.fits</entry>
+ <entry>8 - 11</entry>
+ <entry><ulink url="http://data.astrometry.net/debian/astrometry-data-4204_0.45_all.deb">astrometry-data-4204</ulink></entry>
+ </row>
+ <row>
+ <entry>index-4203-*.fits</entry>
+ <entry>5.6 - 8.0</entry>
+ <entry><ulink url="http://data.astrometry.net/debian/astrometry-data-4203_0.45_all.deb">astrometry-data-4203</ulink></entry>
+ </row>
+ <row>
+ <entry>index-4202-*.fits</entry>
+ <entry>4.0 - 5.6</entry>
+ <entry><ulink url="http://data.astrometry.net/debian/astrometry-data-4202_0.45_all.deb">astrometry-data-4202</ulink></entry>
+ </row>
+ <row>
+ <entry>index-4201-*.fits</entry>
+ <entry>2.8 - 4.0</entry>
+ <entry><ulink url="http://data.astrometry.net/debian/astrometry-data-4201-1_0.45_all.deb">astrometry-data-4201-1</ulink> <ulink url="http://data.astrometry.net/debian/astrometry-data-4201-2_0.45_all.deb">astrometry-data-4201-2</ulink> <ulink url="http://data.astrometry.net/debian/astrometry-data-4201-3_0.45_all.deb">astrometry-data-4201-3</ulink> <ulink url="http://data.astrometry.net/debian/astrometry-data-4201-4_0.45_all.deb">astrometry-data-4201-4</ulink></entry>
+ </row>
+ <row>
+ <entry>index-4200-*.fits</entry>
+ <entry>2.0 - 2.8</entry>
+ <entry><ulink url="http://data.astrometry.net/debian/astrometry-data-4200-1_0.45_all.deb">astrometry-data-4200-1</ulink> <ulink url="http://data.astrometry.net/debian/astrometry-data-4200-2_0.45_all.deb">astrometry-data-4200-2</ulink> <ulink url="http://data.astrometry.net/debian/astrometry-data-4200-3_0.45_all.deb">astrometry-data-4200-3</ulink> <ulink url="http://data.astrometry.net/debian/astrometry-data-4200-4_0.45_all.deb">astrometry-data-4200-4</ulink></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>
+ The Debian packages are suitable for any Debian-based distribution (Ubuntu, Mint...etc). If you downloaded the Debian Packages above for your FOV range, you can install them from your favorite package manager, or via the following command:
+ </para>
+ <para>
+ <command>sudo dpkg -i astrometry-data-*.deb</command>
+ </para>
+ <para>
+ On the other hand, if you downloaded the FITS index files directly, copy them to <filename role="director">/usr/share/astrometry</filename> directory.
+ </para>
+ <note>
+ <para>
+ It is recommended to use a download manager as such <ulink url="https://addons.mozilla.org/en-US/firefox/addon/downthemall/">DownThemAll!</ulink> for Firefox to download the Debian packages as browsers' built-in download manager may have problems with download large packages.
+ </para>
+ </note>
+ </sect4>
+ </sect3>
+
+ <sect3 id="ekos-align-how-to-use">
+ <title>How to Use?</title>
+ <para>
+ Ekos Align Module offers multiple functions to aid you in achieving accurate GOTOs. Start with your mount in home position with the telescope tube looking directly at the celestial pole. For users in Northern Hemisphere, point the telescope as close as possible to Polaris. It is not necessary to perform 2 or 3 star alignments, but it can be useful for some mount types. Make sure your camera is focused and stars are resolved.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Capture & Solve</guilabel>: Capture an image and determine what region in the sky the telescope is exactly looking at. The astrometry results include the equatorial coordinates (RA & DEC) of the center of the captured image in addition to pixel scale and field rotation. Depending on the Solver Action settings, the results can be used to Sync the mount or Sync and then Slew to the target location. For example, suppose you slewed the mount to Vega then used <emphasis>Capture & Solve</emphasis>. If the actual telescope location is different from Vega, it will be first synced to the solved coordinate and then Ekos shall command the mount to slew to Vega. After slew is complete, the Alignment module will repeat Capture & Solve process again until the error between reported and actual position falls below the accuracy thresholds (30 arcseconds by default).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Load & Slew</guilabel>: Load a FITS or JPEG file, solve it, and then slew to it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Polar Alignment Assistant</guilabel>: A simple tool to aid in polar alignment of German Equatorial Mounts.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Legacy Polar Alignment Tool</guilabel>: Measure polar alignment error when a view of the celestial pole (⪚ Polaris for Northern Hemisphere) is not available.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <warning>
+ <para>
+ <emphasis role="bold">Never</emphasis> solve an image at or near the celestial pole (unless Ekos Polar Alignment Assistant Tool is used). Slew at least 20 degrees away from the celestial pole before solving the first image. Solving very close to the poles will make your mount pointing worse so avoid it.
+ </para>
+ </warning>
+ </sect3>
+
+ <sect3 id="ekos-align-alignment-settings">
+ <title>Alignment Settings</title>
+ <screenshot>
+ <screeninfo>
+ Astrometry.net Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="astrometry_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Astrometry.net Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Before you begin the alignment process, select the desired CCD & Telescope. You can explore astrometry.net options that are passed to the astrometry.net solver each time an image is captured:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>CCD</guilabel>: Select CCD to capture from
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Exposure</guilabel>: Exposure duration in seconds
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Accuracy</guilabel>: Acceptable difference between reported telescope coordinate and actually solved coordinate.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Bin X</guilabel>: Set horizontal binning of the CCD
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Bin Y</guilabel>: Set vertical binning of the CCD
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Scope</guilabel>: Set the active telescope in case you have different Primary and Guide scopes. FOV is re-calculated when selecting a different telescope.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Options</guilabel>: Options that are passed to the astrometry.net solver. Click the edit button <inlinemediaobject><imageobject><imagedata fileref="document-edit.png" format="PNG"/></imageobject></inlinemediaobject> to explore the options in detail.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Solver</guilabel>: Select solver type (Online, Offline, Remote). The remote solver is only available when connecting to a remote device.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ By default, the solver will search all over the sky to determine the coordinates of the captured image. This can <emphasis>take a lot of time</emphasis>; therefore, in order to speed up the solver, you can restrict it to only search within a specified area in the sky designated by the RA, DEC, and Radius options above.
+ </para>
+ </sect3>
+
+ <sect3 id="ekos-align-astrometry-net-settings">
+ <title>Astrometry.net Options</title>
+ <para>
+ Options for offline and online solvers.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Astrometry.net Options
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="astrometry_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Astrometry.net Options</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Most of the options are sufficient by default. If you have astrometry.net installed in a non-standard location, you can change the paths as necessary.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>WCS</guilabel>: World-Coordinate-System is a system for embedding equatorial coordinate information within the image. Therefore, when you view the image, you can hover it and view the coordinate for each pixel. You can also click anywhere in the image and command to the telescope to slew there. It is highly recommended to keep this option on.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Verbose</guilabel>: If the solver repeatedly fails to solve, check this option to enable <emphasis>verbose</emphasis> output of the solver to help you identify any problems.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Overlay</guilabel>: Overlay captured images unto the sky map of &kstars;.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Upload JPG</guilabel>: When using online astrometry.net, upload all images are JPEGs to save bandwidth as FITS images can be large.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="ekos-align-solver-options">
+ <title>Solver Options</title>
+ <para>
+ Ekos selects and updates the optimal options by default to accelerate the performance of the solver. You may opt to change the options that are passed to the solver in case the default options are not sufficient.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Solver Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="solver_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Solver Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </sect3>
+
+ <sect3 id="ekos-align-capture-and-solve">
+ <title>Capture & Solve</title>
+ <para>
+ Using Ekos Alignment Module, aligning your mount using the controller's 1, 2, or 3 star alignment is <emphasis>not</emphasis> strictly necessary, though for some mounts it is recommended to perform a rough 1 or 2 star alignment before using Ekos alignment module. If you are using EQMod, you can start using Ekos alignment module right away. A typical workflow for GOTO alignment involves the following steps:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Set your mount to its home position (usually the NCP for equatorial mounts)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select <guilabel>Slew to Target</guilabel> in the <guilabel>Solver Action</guilabel>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Slew to a nearby bright star.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ After slew is complete, click <guibutton>Capture & Solve</guibutton>.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ If the solver is successful, Ekos will sync and then slew to the star. The results are displayed in the Solution Results tab along with a bullseye diagram that shows the offset the reported telescope coordinates (&ie; where the telescope <emphasis>thinks</emphasis> it is looking at) vs. its actual position in the sky as determined by the solver.
+ </para>
+ <para>
+ Each time the solver is executed and returns successful results, Ekos can run on the following actions:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Sync</guilabel>: Syncs the telescope coordinates to the solution coordinates.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Slew to Target</guilabel>: Syncs the telescope coordinates to the solution coordinates and then slew to the target.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Nothing</guilabel>: Just solve the image and display the solution coordinates.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="ekos-align-polaralignment">
+ <title>Polar Alignment</title>
+ <sect4 id="ekos-align-plar-alignment-assistant">
+ <title>Polar Alignment Assistant</title>
+ <para>
+ When setting up a German Equatorial Mount (GEM) for imaging, a critical aspect of capturing long-exposure images is to ensure proper polar alignment. A GEM mount has two axis: Right Ascension (RA) axis and Declination (DE) axis. Ideally, the RA axis should be aligned with the celestial sphere polar axis. A mount's job is to track the star's motion around the sky, from the moment they rise at the eastern horizon, all the way up across the median, and westward until they set.
+ </para>
+
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="595" contentwidth="800" fileref="https://www.stellarmate.com/images/videos/polar_align.webm"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Polar Alignment Assistant</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+
+ <para>
+ In long exposure imaging, a camera is attached to the telescope where the image sensor captures incoming photons from a particular area in the sky. The incident photons have to strike the same photo-site over and over again if we are to gather a clear and crisp image. Of course, actual photons do not behave in this way: optics, atmosphere, seeing quality all scatter and refract photons in one way or another. Furthermore, photons do not arrive uniformly but follow a Poisson distribution. For point-like sources like stars, a point spread function describes how photons are spatially distributed across the pixels. Nevertheless, the <emphasis>overall</emphasis> idea we want to keep the source photons hitting the same pixels. Otherwise, we might end up with an image plagued with various trail artifacts.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Polar Alignment
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="alignment_polaris.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Polar Alignment</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Since mounts are not perfect, they cannot perfectly keep track of object as it transits across the sky. This can stem from many factors, one of which is the misalignment of the mount's Right Ascension axis with respect to the celestial pole axis. Polar alignment removes one of the biggest sources of tracking errors in the mount, but other sources of error still play a factor. If properly aligned, some mounts can track an object for a few minutes with the only deviation of 1-2 arcsec RMS.
+ </para>
+ <para>
+ However, unless you have a top of the line mount, then you'd probably want to use an autoguider to keep the same star locked in the same position over time. Despite all of this, if the axis of the mount is not properly aligned with the celestial pole, then even a mechanically-perfect mount would lose tracking with time. Tracking errors are proportional to the magnitude of the misalignment. It is therefore very important for long exposure imaging to get the mount polar aligned to reduce any residual errors as it spans across the sky.
+ </para>
+ <para>
+ Before starting the process, point the mount as close as possible to the celestial pole. If you are living in the Northern Hemisphere, point it as close as possible to Polaris.
+ </para>
+ <para>
+ The tool works by capturing and solving three images. After capturing each, the mount rotates by a fixed amount and another image is captured and solved.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Polar Alignment Assistant
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="polar_assistant_main.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Polar Alignment Assistant</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ After the first capture, you can rotate the mount by a specific amount (default 30 degrees) either West or East. After selecting the magnitude and direction, click <guibutton>Next</guibutton> to continue and the mount will be rotated. Once the rotation is complete you shall be asked to take another capture, unless you have checked <guilabel>Auto Mode</guilabel>. In Automated mode, the rest of the process will continue with the same settings and direction until a total of three images are captured.
+ </para>
+ <para>
+ Since the mount's true RA/DE are resolved by astrometry, we can construct a unique circle from the three centers found in the astrometry solutions. The circle's center is where the mount rotates about (RA Axis) and ideally, this point should coincide with the celestial pole. However, if there is a misalignment, then Ekos draws a correction vector. This correction vector can be placed anywhere in the image. Next, <emphasis>refresh</emphasis> the camera feed and make corrections to the mount's Altitude and Azimuth knobs until the star is located in the designated cross-hair. To make it easy to make corrections, expand the view by clicking on the Fullscreen button <inlinemediaobject><imageobject><imagedata fileref="view-fullscreen.png" format="PNG"/></imageobject></inlinemediaobject>
+ </para>
+ <screenshot>
+ <screeninfo>
+ Polar Alignment Result
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="polar_alignment_result.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Polar Alignment Result</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ If you are away from StellarMate or PC, you can use your Tablet to monitor the camera feed while making corrections. Use the <link linkend="ekos-tutorials-viewer">StellarMate's web-based VNC viewer</link> or use any VNC Client on your tablet to access StellarMate. If Ekos is running on your PC, you can use applications like TeamViewer to achieve the same results. The following is a video demonstrating how to utilize the Polar Alignment Assistant tool.
+ </para>
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="315" contentwidth="560" fileref="https://www.youtube.com/embed/sx6Zz9lNd5Q"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Polar Alignment</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+ </sect4>
+ <sect4 id="ekos-align-legacy-polar-alignment-workflow">
+ <title>Legacy Polar Alignment Workflow</title>
+ <para>
+ Using the Polar Alignment mode, Ekos can measure and correct for polar alignment errors. To measure Azimuth error, point your mount to a star close to the meridian. If you live in the northern hemisphere, you will point the mount toward the southern meridian. Click on <guibutton>Measure Az Error</guibutton> to begin the process. Ekos will try to measure the drift between two images and calculates the error accordingly. You can ask Ekos to correct Azimuth error by clicking on the <guibutton>Correct Az Error</guibutton> button. Ekos will slew to a new location and asks you to adjust the mount's azimuth knobs until the star is in the center of the Field of View. You can use the Focus Module's Framing feature to take a look at the image as you make your adjustments.
+ </para>
+ <para>
+ Similarly, to measure Altitude error, click on the <guibutton>Measure Alt Error</guibutton> button. You need to point your mount either east or west and set the <guilabel>Altitude Direction</guilabel> combo box accordingly. Ekos will take two images and calculates the error. You can ask Ekos to correct Altitude error by clicking on the <guibutton>Correct Alt Error</guibutton> button. As with Azimuth correction, Ekos will slew to a new location and asks you to adjust the mount's altitude knobs until the star is in the center of the FOV.
+ </para>
+ <para>
+ After making a correction, it is recommended to measure the Azimuth and Altitude errors again and gauge the difference. You may need to perform the correction more than once to obtain optimal results.
+ </para>
+ <para>
+ Before starting the Polar Alignment tool, you must complete the GOTO Workflow above for at least one point in the sky. Once your mount is aligned, proceed with the following (assuming you live in the northern hemisphere):
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Slew to a <emphasis role="bold">bright</emphasis> star (4th magnitude or below) near the southern meridian (Azimuth 180). Make sure <guilabel>Slew to Target</guilabel> is selected. Capture and solve. The star should be exactly centered in your CCD field of view.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Switch mode to <guilabel>Polar Alignment</guilabel>. Click <guibutton>Measure Az Error</guibutton>. It will ask you to slew to a star at the southern meridian which we already done click <guibutton>Continue</guibutton>. Ekos will now perform the error calculation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If all goes well, the error is displayed in the output boxes. To correct for the error, click <guibutton>Correct Az Error</guibutton>. Ekos will now slew to a different point in the sky, and you will be required to <emphasis role="bold">ONLY</emphasis> adjust the mount's azimuth knobs to center the star in the field of view. The most convenient way of monitoring the star field is by going to the <guilabel>Focus</guilabel> module and clicking <guibutton>Start Framing</guibutton>. If the azimuth error is great, the star might not be visible in the CCD field of view, and therefore you have to make <emphasis>blind</emphasis> adjustments (or simply look through the finderscope) until the star enters the CCD FOV.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Begin your azimuth adjustments until the bright star you slewed to initially is as close to center as you can get it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guibutton>Stop Framing</guibutton> in the <link linkend="ekos-focus">Focus module</link>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Repeat the <guibutton>Measure Az Error</guibutton> to ensure we indeed corrected the error. You might have to run it more than once to ensure the results are valid.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Switch mode to <guilabel>GOTO</guilabel>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Now slew to a <emphasis role="bold">bright</emphasis> star either on the eastern or western horizon, preferably above 20 degrees of altitude. It has to be as close as possible to the eastern (90 azimuth) or western (270) cardinal points.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ After slew is complete, capture and solve. The star should be dead center in the CCD FOV now.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Switch mode to <guilabel>Polar Alignment</guilabel>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click <guibutton>Measure Alt Error</guibutton>. It will ask you to slew to a star at either the eastern (Azimuth 90) or western (Azimuth 270) which we already done click <guibutton>Continue</guibutton>. Ekos will now perform the error calculation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ To correct for the error, click <guibutton>Correct Alt Error</guibutton>. Ekos will now slew to a different point in the sky, and you will be required to <emphasis role="bold">ONLY</emphasis> adjust the mount's altitude knobs to center the star in the field of view. Start framing as done before in the focus module to help you with the centering.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ After centering is complete, stop framing.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Repeat the <guibutton>Measure Alt Error</guibutton> to ensure we indeed corrected the error. You might have to run it more than once to ensure the results are valid.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Polar alignment is now complete!</para>
+ </listitem>
+ </orderedlist>
+ <warning>
+ <para>
+ The mount may slew to a dangerous position and you might risk hitting the tripod and/or other equipment. Carefully monitor the mount's motion. Use at your own risk.
+ </para>
+ </warning>
+ </sect4>
+ </sect3>
+ </sect2>
diff --git a/doc/ekos-capture.docbook b/doc/ekos-capture.docbook
new file mode 100644
index 000000000..e4a22b6d0
--- /dev/null
+++ b/doc/ekos-capture.docbook
@@ -0,0 +1,558 @@
+<sect2 id="ekos-capture">
+ <title>Capture</title>
+ <indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Capture</tertiary>
+ </indexterm>
+ <screenshot>
+ <screeninfo>
+ Ekos Capture
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_capture.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos Capture</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ The CCD Module is your primary image and video acquisition module in Ekos. It enables you to capture single (Preview), multiple images (Sequence Queue), or record <ulink url="https://sites.google.com/site/astropipp/ser-player">SER</ulink> videos along with a selection of filter wheel and rotator, if available.
+ </para>
+ <sect3 id="capture-ccd-filter-wheel">
+ <title>CCD & Filter Wheel Group</title>
+ <para>
+ Select the desired CCD/DSLR and Filter Wheel (if available) for capture. Set CCD temperature and filter settings.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>CCD</guilabel>: Select the active CCD camera. If your camera has a guide head, you can select it from here as well.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>FW</guilabel>: Select the active Filter Wheel device. If your camera has a built-in filter wheel, the device would be the same as the camera.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Cooler</guilabel>: Toggle Cooler On/Off. Set the desired temperature, if your camera is equipped with a cooler. Check the option to force temperature setting before any capture. Capture process is only started after the measured temperature is within requested temperature tolerance. The <emphasis>default</emphasis> tolerance is 0.1 degrees Celsius but can be adjusted in <guilabel>Capture</guilabel> options under Ekos configuration.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+ <sect3 id="capture-settings">
+ <title>Capture Settings</title>
+ <screenshot>
+ <screeninfo>
+ Capture Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="capture_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Capture Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Set all capture parameters as detailed below. Once set, you can capture a preview by click on <guibutton>Preview</guibutton> or add a job to the sequence queue.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Exposure</guilabel>: Specify exposure duration in seconds.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Filter</guilabel>: Specify the desired filter.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Count</guilabel>: Number of images to capture
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Delay</guilabel>: Delay in seconds between image captures.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Type</guilabel>: Specify the type of desired CCD frame. Options are <guimenuitem>Light</guimenuitem>, <guimenuitem>Dark</guimenuitem>, <guimenuitem>Bias</guimenuitem>, and <guimenuitem>Flat</guimenuitem> frames.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>ISO</guilabel>: For DSLR cameras, specify the ISO value.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Format</guilabel>: Specify capture save format. For all CCDs, only <guimenuitem>FITS</guimenuitem> option is available. For DSLR cameras, you can an additional option to save in <guimenuitem>Native</guimenuitem> format (⪚ RAW or JPEG).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Custom Properties</guilabel>: Set extended properties available in the camera to the job settings.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Calibration</guilabel>: For Dark &s; Flat frames, you can set additional options explained in the <link linkend="capture-calibration-frames">Calibration Frames section below</link>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Frame</guilabel>: Specify the left (X), top (Y), width (W), and height (H) of the desired CCD frame. If you changed the frame dimensions, you can reset it to default values by clicking on the reset button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Binning</guilabel>: Specify horizontal (X) and vertical (Y) binning.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <sect4 id="capture-custom-properties">
+ <title>Custom Properties</title>
+ <para>
+ Many cameras offer additional properties that cannot be directly set in the capture settings using the common control. The capture controls described above represent the most common settings shared among different cameras, but each camera is unique and may offer its own extended properties. While you can use INDI Control Panel to set any property in the driver; it is important to be able to set such property for each job in the sequence. When you click <guibutton>Custom Properties</guibutton>, a dialog is shown divided into <guilabel>Available Properties</guilabel> and <guilabel>Job Properties</guilabel>. When you move an <guilabel>Available Properties</guilabel> to the <guilabel>Job Property</guilabel> list, its current value can be recorded once you click <guibutton>Apply</guibutton>. When you add a job to the <guilabel>Sequence Queue</guilabel>, the properties values selected in the <guilabel>Job Properties</guilabel> list shall be recorded and saved.
+ </para>
+ <para>
+ The following video explains this concept is more detail with a live example:
+ </para>
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="450" contentwidth="800" fileref="https://www.stellarmate.com/images/fss/videos/custom_properties.mp4"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Custom Properties feature</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+ </sect4>
+ </sect3>
+
+ <sect3 id="capture-file-settings">
+ <title>File Settings</title>
+
+ <screenshot>
+ <screeninfo>
+ File Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="file_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>File Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Settings for specifying where captured images are saved to, and how to generate unique file names in addition to upload mode settings.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Prefix</guilabel>: Specify the prefix to append to the generated filename. You may also append the frame type, filter, expose duration, and ISO 8601 timestamp. For example, if you specify Prefix as <userinput>M45</userinput> and checked the Type and Filter checkboxes, and assuming your filter was set to <guimenuitem>Red</guimenuitem> and your frame type is <guimenuitem>Light</guimenuitem>, the generated file names will be as follows:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ M45_Light_Red_001.fits
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ M45_Light_Red_002.fits
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ If <guilabel>TS</guilabel> was checked, a timestamp will be appended to the filename, ⪚
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ M45_Light_Red_001_2016-11-09T23-47-46.fits</para>
+ </listitem>
+ <listitem>
+ <para>
+ M45_Light_Red_002_2016-11-09T23-48-34.fits</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Script</guilabel>: Specify an <emphasis>optional</emphasis> script to be executed after each capture is complete. The full path of the script must be specified and it must executable. To denote success, the script must return zero as this would allow the sequence to continue. If a non-zero value is returned by the script, the sequence is aborted.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Directory</guilabel>: Local directory to save the sequence images to.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Upload</guilabel>: Select how captured images are uploaded:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ <guilabel>Client</guilabel>: Captured images are only uploaded to Ekos and saved to the local directory specified above.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Local</guilabel>: Captured images are only saved locally on the remote computer.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Both</guilabel>: Captured images are saved on the remote device <emphasis role="bold">and</emphasis> uploaded to Ekos.</para>
+ </listitem>
+ </orderedlist>
+ <para>
+ When selecting <guimenuitem>Local</guimenuitem> or <guimenuitem>Both</guimenuitem>, you must specify the remote directory where the remote images are saved to. By default, all captured images are uploaded to Ekos.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Remote</guilabel>: When selecting either <guimenuitem>Local</guimenuitem> or <guimenuitem>Both</guimenuitem> modes above, you must specify the remote directory where remote images are saved to.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="capture-limit-settings">
+ <title>Limit Settings</title>
+
+ <screenshot>
+ <screeninfo>
+ Limit Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="limit_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Limit Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Limit settings are applicable to all the images in the sequence queue. When a limit is exceeded, Ekos shall command the appropriate action to remedy the situation as explained below.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Guiding Deviation</guilabel>: If checked, it enforces a limit of maximum allowable guiding deviation for the exposure, if autoguiding is used. If the guiding deviation exceeds this limit in arcseconds, it aborts the exposure sequence. It will automatically resume the exposure sequence again once the guiding deviation goes below this limit.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Autofocus if HFR exceeds a value</guilabel>: If autofocus is enabled in the focus module and at least one autofocus operation was completed successfully, you can set the maximum acceptable HFR value. If this option is enabled then between consecutive exposures, the HFR value is recalculated, and if found to exceed the maximum acceptable HFR value, then an autofocus operation is automatically triggered. If the autofocus operation is completed successfully, the sequence queue resumes, otherwise, the job is aborted.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Meridian Flip</guilabel>: If supported by the mount, set the hour angle limit (in hours) before a <ulink url="http://astronomy.mdodd.com/gem_movement.html">meridian flip</ulink> is commanded. For example, if you set the meridian flip duration to 0.1 hours. Ekos shall wait until the mount passes the meridian by 0.1 hours (6 minutes), then it commands the mount to perform a meridian flip. After the meridian flip is complete, Ekos re-aligns using astrometry.net (if <link linkend="ekos-align">the alignment</link> was used) and resumes guiding (if it was started before) and then resumes the capture process automatically.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="capture-sequence-queue">
+ <title>Sequence Queue</title>
+
+ <para>
+ Sequence Queue is the primary hub of the Ekos Capture Module. This is where you can plan and execute jobs using the sequence queue built-in powerful editor. To add a job, simply select all the parameters from the capture and file settings as indicated above. Once you selected your desired parameters, click on the add button <inlinemediaobject><imageobject><imagedata fileref="list-add.png" format="PNG"/></imageobject></inlinemediaobject> in the sequence queue to add it to the queue.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Sequence Queue
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="sequence_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Sequence Queue</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ You can add as many jobs as desired. While it is not strictly necessary, it is preferable to add the dark and flat jobs after the light frames. Once you are done adding jobs, simply click <guilabel>Start Sequence</guilabel> <inlinemediaobject><imageobject><imagedata fileref="media-playback-start.png" format="PNG"/></imageobject></inlinemediaobject> to begin executing the jobs. A job state changes from <guilabel>Idle</guilabel> to <guilabel>In Progress</guilabel> and finally to <guilabel>Complete</guilabel> once it is done. The Sequence Queue automatically starts the next job. If a job is aborted, it may be resumed again. To pause a sequence, click the pause button <inlinemediaobject><imageobject><imagedata fileref="media-playback-pause.png" format="PNG"/></imageobject></inlinemediaobject> and the sequence will be stopped after the current capture is complete. To reset the status of all the jobs, simply click the reset button <inlinemediaobject><imageobject><imagedata fileref="view-refresh.png" format="PNG"/></imageobject></inlinemediaobject>. Please beware that all image progress counts are reset as well. To preview an image in &kstars; FITS Viewer, click the <guibutton>Preview</guibutton> button.
+ </para>
+ <para>
+ Sequence queues can be saved as an XML file with extension <filename role="extension">.esq</filename> (Ekos Sequence Queue). To load a sequence queue, click the open document button <inlinemediaobject><imageobject><imagedata fileref="document-open.png" format="PNG"/></imageobject></inlinemediaobject>. Please note that it will replace any current sequence queues in Ekos.
+ </para>
+
+ <important>
+ <para>
+ <emphasis role="bold">Job Progress</emphasis>: Ekos is designed to execute and resume the sequence over multiple nights if required. Therefore, if <guilabel>Remember Job Progress</guilabel> option is enabled in Ekos Options, Ekos shall scan the file system to count how many images are already completed and will resume the sequence from where it was left off. If this default behavior is not desired, simply turn off <guilabel>Remember Job Progress</guilabel> under options.
+ </para>
+ </important>
+
+ <para>
+ To edit a job, double click it. You will notice the add button <inlinemediaobject><imageobject><imagedata fileref="list-add.png" format="PNG"/></imageobject></inlinemediaobject> now changed to check mark button <inlinemediaobject><imageobject><imagedata fileref="dialog-ok-apply.png" format="PNG"/></imageobject></inlinemediaobject>. Make your changes on the left-hand side of the CCD module and once done, click on the check mark button. To cancel a job edit, click anywhere on the empty space within the sequence queue table.
+ </para>
+ <para>
+ If your camera supports live video feed, then you can click the <guibutton>Live Video</guibutton> button to start streaming. The video stream window enables recording and subframing of the video stream. For more information, check the video below:
+ </para>
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="315" contentwidth="560" fileref="https://www.youtube.com/embed/qRsAqTL4ZZI"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Recording feature</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+ </sect3>
+
+ <sect3 id="capture-filter-settings">
+ <title>Filter Settings</title>
+
+ <screenshot>
+ <screeninfo>
+ Filter Queue
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="filter_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Filter Queue</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ Click the filter icon <inlinemediaobject><imageobject><imagedata fileref="view-filter.png" format="PNG"/></imageobject></inlinemediaobject> next to the filter wheel selection box to open the filter settings dialog. If you are using filters that are not parafocal with each other and require a specific amount of focus offsets in order to get them into proper then set all the relative focus offsets in the dialog.
+ </para>
+ <para>
+ Configure settings for each filter individually:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ <guilabel>Filter</guilabel>: Filter Name
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Exposure</guilabel>: Set exposure time used when performing focus under this filter. By default, it is set to 1 second.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Offset</guilabel>: Set relative offsets. Ekos will command a focus offset change if there is a difference between the current and target filter offsets. For example, given the values in the example image to the right, if the current filter is set to <emphasis>Red</emphasis> and next filter is <emphasis>Green</emphasis>, then Ekos shall command the focuser to Focus In by +300 ticks. Relative positive focus offsets denote Focus Out while negative values denote Focus In.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Auto Focus</guilabel>: Check this option to initial AutoFocus process whenever the filter is changed to this filter.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Lock Filter</guilabel>: Set which filter should be set and <emphasis>locked</emphasis> when performing autofocus for this filter.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ Let's take an example. Suppose the capture sequence is running and the current filter is <guilabel>Green</guilabel>, so the relative already offset is set to +300. The next image in the sequence uses Hydrogen Alpha (H_Alpha) so before Ekos captures the next frame, the following actions take place:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Since Luminosity is specified as the locked filter and auto-focus is checked, the filter is changed to Luminosity
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A focus offset is -300 is applied since the prior filter <guilabel>Green</guilabel> was moved +300 previously.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Auto Focus process is initiated.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Once Auto Focus is complete, the filter is changed to H_Alpha.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A focus offset of -1200 is applied.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Capture sequence is resumed.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="capture-fits-viewer">
+ <title>FITS Viewer</title>
+
+ <para>
+ Captured images are displayed in &kstars; FITS Viewer tool, and also in the summary screen. Set options related to how the images are displayed in the viewer.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Auto Dark</guilabel>: You can capture an image and auto dark subtract it by checking this option. Note that this option is only applicable when using <guilabel>Preview</guilabel>, you cannot use it in batch mode sequence queue.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Effects</guilabel>: Image enhancement filter to be applied to the image after capture.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="capture-rotation-settings">
+ <title>Rotator Settings</title>
+
+ <screenshot>
+ <screeninfo>
+ Rotator Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_rotator_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Rotator Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ Field Rotators are supported in INDI & Ekos. The rotator angle is the raw angle reported by the rotator and is not necessary the <ulink url="https://en.wikipedia.org/wiki/Position_angle">Position Angle</ulink>. A Position Angle of <emphasis>zero</emphasis> indicates that the frame top (indicated by small arrow) is pointing <emphasis>directly</emphasis> at the pole. The position angle is expressed as E of N (East of North), so 90 degrees PA indicates the frame <emphasis>top</emphasis> points 90 degrees away (counter-clockwise) from the pole. Check <ulink url="http://www.srl.caltech.edu/NuSTAR_Public/NuSTAROperationSite/file/NuSTAR-PA.pdf">examples</ulink> for various PAs.
+ </para>
+ <para>
+ To calibrate the Position Angle (PA), capture and solve an image in the Ekos Align module. An <emphasis>offset</emphasis> and a <emphasis>multiplier</emphasis> are applied to the raw angle to produce the position angle. The Ekos Rotator dialog permits direct control of the raw angle and also the PA. The offset and multiplier can be changed manually to synchronize the rotator's raw angle with the actual PA. Check <guilabel>Sync FOV to PA</guilabel> to rotate the current Field of View (FOV) indicator on the Sky Map with the PA value as you change it in the dialog.
+ </para>
+
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="315" contentwidth="560" fileref="https://www.youtube.com/embed/V_hRPMlPjmA"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Rotator settings</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+
+ <para>
+ Each capture job may be assigned different rotator angles, but be aware that this would cause guiding to abort as it would lose track of the guide star when rotating. Therefore, for most sequences, the rotator angle is kept the same for all capture jobs.
+ </para>
+ </sect3>
+
+ <sect3 id="capture-calibration-frames">
+ <title>Calibration Frames</title>
+
+ <screenshot>
+ <screeninfo>
+ Calibration settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="calibration_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Calibration settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ For Flat Field frames, you can set calibration options in order to automate the process. The calibration options are designed to facilitate automatic unattended flat field frame capture. It can also be used for dark and bias frames if desired. If your camera is equipped with a mechanical shutter, then it is not necessary to set calibration settings unless you want to close the dust cover to ensure no light at all passes through the optical tube. For flat fields, you must specify the flat field light source, and then specify the duration of the flat field frame. The duration can be either manual or based on ADU calculations.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Flat Field Source
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Manual</guilabel>: The flat light source is manual.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Dust Cover with Built-In Flat Light</guilabel>: If using a dust cover with builtin light source (⪚ FlipFlat). For dark and bias frames, close the dust cap before proceeding. For flat frames, close the dust cap and turn on the light source.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Dust Cover with External Flat Light</guilabel>: If using a dust cover with an external flat light source. For dark and bias frames, close the dust cap before proceeding. For flat frames, open the dust cap and turn on the light source. The external flat light source location is presumed to be the parking location.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Wall</guilabel>: Light source is a panel on the observatory wall. Specify the Azimuth and Altitude coordinates of the panel and the mount shall slew there before capturing the flat field frames. If the light panel is controllable from INDI, Ekos shall turn it on/off as required.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Dawn/Dusk</guilabel>: Currently unsupported.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Flat Field Duration
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Manual</guilabel>: Duration is as specified in the Sequence Queue.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>ADU</guilabel>: Duration is variable until specified ADU is met.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ Before the calibration capture process is started, you can request Ekos to park the mount and/or dome. Depending on your flat source selection above, Ekos will use the appropriate flat light source before starting flat frames capture. If ADU is specified, Ekos begins by capturing a couple of preview images to establish the curve required to achieve the desired ADU count. Once an appropriate value is calculated, another capture is taken and ADU is recounted until a satisfactory value is achieved.
+ </para>
+ </sect3>
+
+ <sect3 id="capture-video-tutorials">
+ <title>Video Tutorials</title>
+
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="315" contentwidth="560" fileref="https://www.youtube.com/embed/Gz07j7VPnpc"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Capture</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="315" contentwidth="560" fileref="https://www.youtube.com/embed/yfz9_UJIvLY"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Filter Wheels</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+ </sect3>
+</sect2>
diff --git a/doc/ekos-fits-viewer.docbook b/doc/ekos-fits-viewer.docbook
new file mode 100644
index 000000000..b8cacef11
--- /dev/null
+++ b/doc/ekos-fits-viewer.docbook
@@ -0,0 +1,314 @@
+<sect2 id="ekos-fits-viewer">
+ <title>FITS Viewer</title>
+ <indexterm>
+ <primary>FITS Viewer</primary>
+ </indexterm>
+ <para>
+ The Flexible Image Transport System (FITS) is the standard format for representing images and data in Astronomy.
+ </para>
+ <screenshot>
+ <screeninfo>
+ FITS Viewer in action
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="kstars_m44_mac.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>FITS Viewer in action</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ The &kstars; FITS Viewer tool is integrated with Ekos for seamless display of captured FITS images. It can be used as a standalone tool or embedded within Ekos modules. To open a FITS file, select <guimenuitem>Open FITS...</guimenuitem> from the <guimenu>File</guimenu> menu, or press <keycombo>&Ctrl; <keycap>O</keycap></keycombo>.
+ </para>
+ <para>
+ In addition to image display, the viewer can process World-Coordinate-System (WCS) header if present within the FITS file and provides useful information regarding the objects found within the image, equatorial grid overlay, popup menu, and the ability to slew the mount (if connected) to any point within the image.
+ </para>
+ <para>
+ Several filters can be applied to enhance the image include auto stretch and high contrast. Depending on the image size, these operations can take a few seconds to complete. The bottom status bar displays the current pixel value and current X & Y coordinates of the mouse pointer within the image. Furthermore, it includes the current zoom level and the image resolution.
+ </para>
+ <para>
+ When loading a bayered image, the viewer can automatically debayer the image if <emphasis>Auto Debayer</emphasis> is checked in the FITS Settings. The debayering operation fetches the bayer pattern (⪚ RGGB) from the FITS header. If none exists, you can alter the debayering algorithm and pattern from the <guimenu>File</guimenu> menu or by using the <keycombo>&Ctrl; <keycap>D</keycap></keycombo> shortcut.
+ </para>
+ <para>
+ Since operations such as auto debayering and auto WCS are computationally expensive and stress the processor on low-powered embedded devices, you can toggle their behavior in <link linkend="fits-configure">&kstars; Settings FITS page</link>.
+ </para>
+ <screenshot>
+ <screeninfo>
+ FITS Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="fits_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>FITS Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Hovering over any option shall display a detailed tooltip that explains its function.
+ </para>
+ <sect3 id="fits-viewer-features">
+ <title>Features</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Support for 8, 16, 32, IEEE-32, and IEEE-64 bits formats.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Support Color FITS images (3D Cubes) and Bayered FITS images.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Histogram with linear, logarithmic, and square-root scales.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Brightness/Contrast controls.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Pan and Zoom.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Auto levels.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Statistics.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Rectangular and Equatorial Grids (if WCS info is present).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Detection and highlight of stars.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ FITS header query.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Undo/Redo.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term>Histogram</term>
+ <listitem>
+ <screenshot>
+ <screeninfo>
+ Histogram
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="fitsviewer_histogram.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Histogram</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Displays multi-channel FITS histogram. The user can rescale the image by optionally defining an upper and lower limit for the cutoff region. The rescaling operation (linear, logarithmic, or square-root) may then be applied to the region enclosed by the upper and lower limits.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>FITS Header</term>
+ <listitem>
+ <para>
+ Displays a read-only table listing FITS header keywords and values.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Statistics</term>
+ <listitem>
+ <para>
+ Provides simple statistics for minimum and maximum pixel values and their respective locations. FITS depth, dimension, mean, and standard deviation.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="fits-viewer-embedded">
+ <title>Embedded FITS Viewer</title>
+ <screenshot>
+ <screeninfo>
+ FITS Viewer embedded
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="fitsviewer_embedded.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>FITS Viewer embedded</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ In Ekos <link linkend="ekos-focus">Focus</link>, <link linkend="ekos-guide">Guide</link>, and <link linkend="ekos-align">Align</link> modules, captured images are displayed in the embedded FITS Viewer. The embedded viewer includes a <emphasis>floating bar</emphasis> that can be used to perform several functions:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Zoom Out
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Zoom In
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Default Zoom
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Zoom To Fit
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Toggle Cross Hairs
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Toggle Pixel Gridlines
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Toggle Detected Stars: Highlight detected stars with red circles.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Star Profile: View detailed 3D star profile.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The floating bar is automatically hidden once the mouse leaves the embedded viewer area. You can use the mouse to pan and zoom just like the standalone FITS Viewer tool. The green tracking box can be used to select a specific star or region within the image, for example, to select a guide star.
+ </para>
+ </sect3>
+
+ <sect3 id="fits-viewer-3d-star-profile">
+ <title>3D Star Profile & Data Visualization Tool</title>
+ <screenshot>
+ <screeninfo>
+ Star Profile main page
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="star_profile_main.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Star Profile main page</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ The 3D data visualization tool can plot 3D graphs of the selected region of the image. This is particularly useful for astrophotographers who want to visualize the profile of a star they are considering focusing or guiding on. For scientists, it enables them to examine a cross-section of the data to understand the relative brightness of different objects in the image. Additionally, it empowers imagers who want to visually see what is going on in their data collection in a new way.
+ </para>
+ <para>
+ To use the new feature, the user needs to select the <guiicon>View Star Profile</guiicon> icon in one of the Ekos Module Views, or in the FITS Viewer. Then, the region selected in the green tracking box will show up in the 3D graph as shown above. The user will then have one of the following toolbars at the bottom.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Star Profile toolbar 1
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="star_profile_toolbar1.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Star Profile toolbar 1</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <screenshot>
+ <screeninfo>
+ Star Profile toolbar 2
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="star_profile_toolbar2.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Star Profile toolbar 2</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ At the far left, the sample size combo box will let the user select the size of the image crop shown in the graph. This option is only available in the <guilabel>Summary Screen</guilabel>, the <link linkend="ekos-align">Align Module</link>, and the FITS Viewer. The second combo box lets the user control whether they are selecting an individual item, or a row, or a column of pixels. The slice button will be enabled if the user selects <guimenuitem>Row</guimenuitem> or <guimenuitem>Column</guimenuitem>. It will put the graph in slice mode so that the user can see a cross-section view of the image. Third, is a checkbox that will open up two sliders that will let the user drag the slider to change the selection. This is extremely useful in the slide mode to change the selected point and to move the cross section around the graph. It is also useful in the normal view when in <guilabel>Explore Mode</guilabel> so that the user can zoom around the image examining the pixels.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Star Profile, examine pixels
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="star_profile_examine_pixels.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Star Profile, examine pixels</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Then the user has the <guilabel>Zoom To</guilabel> combo box, which the user can use to zoom the graph to different preset locations. Next is the combo box that lets the user select the color scheme of the graph. Then are the HFR and the Peak checkboxes, which will both turn on the HFR and Peak labels on each found star in the image, but will also display one of them at the bottom of the screen. And finally comes the Scaling checkbox, which enables the <guilabel>Scaling</guilabel> Side Panel. There are three sliders in that panel, one to control the minimum value displayed on the graph or <quote>black point</quote>, one to control the maximum value displayed in the graph or the <quote>white point</quote>, and a third that is disabled by default that lets the user control the cutoff value for data displayed on the graph.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Star Profile vertical page
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="star_profile_vertical.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Star Profile vertical</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ This third slider is very useful to get really big peaks out of the way so you can study the finer details in the image. There is a checkbox at the top to enable/disable the cutoff slider. And finally at the bottom of the sliders is the “Auto scale” button. This will auto scale the sliders as you sample different areas in the image. It will not only optimize the display of the data but will also affect the minimum and maximum points of the slider. If you disable auto scale, then as you sample different parts of the image, they will be displayed at the same scale. A particularly useful way to use this is to select an area of your image using auto scale, tweak the min, max, and cutoff sliders to your liking, and then turn off the auto scale feature to explore other areas of the graph.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Star Profile final page
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="star_profile_final.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Star Profile final page</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </sect3>
+</sect2>
diff --git a/doc/ekos-focus.docbook b/doc/ekos-focus.docbook
new file mode 100644
index 000000000..bd6c257f5
--- /dev/null
+++ b/doc/ekos-focus.docbook
@@ -0,0 +1,253 @@
+<sect2 id="ekos-focus">
+ <title>Focus</title>
+ <indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Focus</tertiary>
+ </indexterm>
+ <sect3 id="focus-theory">
+ <title>Theory Of Operation</title>
+
+ <screenshot>
+ <screeninfo>
+ Ekos Focus
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_focus.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos Focus</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ In order to focus an image, Ekos needs to establish a numerical method for gauging how <emphasis>good</emphasis> your focus is. It's easy when you look at an image and can see it as <emphasis>unfocused</emphasis>, as the human is very good at detecting that, but <emphasis>how</emphasis> can Ekos possibly know that?
+ </para>
+ <para>
+ There are multiple methods. One is to calculate the Full Width at Half Maximum (FHWM) of a star profile within an image, and then adjust the focus until an optimal (narrower) FWHM is reached. The problem with FWHM is that it assumes the initial focus position to be close to the critical focus. Additionally, FWHM does not perform very well under low-intensity fluxes. An Alternative method is Half-Flux-Radius (HFR), which is a measure of the width in pixels counting from the center of the stars until the accumulated intensity is half of the total flux of the star. HFR proved to be much more stable in conditions where you might have unfavorable sky conditions, when the brightness profile of the stars is low, and when the starting position of the focus is far from the optimal focus.
+ </para>
+ <para>
+ After Ekos processes an image, it selects the brightest star and starts measuring its HFR. It can automatically select the star, or you can select the star manually. It is usually recommended to select stars that are not too bright as they might get saturated during the focusing process. A magnitude 3 or 4 star is often sufficient.
+ </para>
+ <para>
+ Ekos then begins the focusing process by commanding the focuser to focus inwards or outwards, and re-measures the HFR. This establishes a V-shaped curve in which the sweet spot of optimal focus is at the center of the V-curve, and the slope of which depends on the properties of the telescope and camera in use. In Ekos, a full V-curve is never constructed as the focusing process works iteratively, so under most circumstances, a half V-curve shape as illustrated in the Focus Module image is measured.
+ </para>
+ <para>
+ Because the HFR varies linearly with focus distance, it is possible to calculate the optimal focus point. In practice, Ekos operates iteratively by moving in discrete steps, decided initially by the user-configurable step size and later by the slope of the V-curve, to get closer to the optimal focus position where it then changes gears and performs smaller, finer moves to reach the optimal focus. In the default <guilabel>Iterative</guilabel> algorithm, the focus process stops when the measured HFR is within the configurable tolerance of the minimum recorded HFR in the process. In other words, whenever the process starts searching for a solution within a narrowly limited range, it checks if the current HFR is within % difference compared to the minimum HFR recorded, and if this condition is met then the autofocus process is considered successful. The default value is set to 1% and is sufficient for most situations. The <guilabel>Step</guilabel> options specify the number of <emphasis>initial</emphasis> ticks the focuser has to move. If the image is severely out of focus, we set the step size high (&ie; > 250). On the other hand, if the focus is close to optimal focus, we set the step size to a more reasonable range (< 50). It takes trial and error to find the best starting tick, but Ekos only uses that for the first focus motion, as all subsequent motions depend on the V-Curve slope calculations.
+ </para>
+ <para>
+ When using the <guilabel>Polynomial</guilabel> algorithm, the process starts in the <guilabel>Iterative</guilabel> mode, but once we cross to the other side of the V-curve (&ie; once HFR values start increasing again after decreasing for a while), the Ekos performs polynomial fitting to find a solution that predicts the minimum possible HFR position. If a valid solution is found, the autofocus process is considered successful.
+ </para>
+ <para>
+ While Ekos Focus Module supports relative focusers, it is <emphasis role="bold">highly recommended</emphasis> to use absolute focusers.
+ </para>
+ </sect3>
+
+ <sect3 id="focus-focuser-group">
+ <title>Focuser Group</title>
+
+ <screenshot>
+ <screeninfo>
+ Focuser Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="focuser_group.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Focuser Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ Any INDI-compatible focuser is supported. It is recommended to use <emphasis role="bold">absolute</emphasis> focusers since their absolute position is known on power up. In INDI, the focuser <emphasis>zero</emphasis> position is when the drawtube is <emphasis role="bold">fully retracted</emphasis>. When focusing <emphasis>outwards</emphasis>, the focuser position increases, while it decreases when focusing <emphasis>inwards</emphasis>. The following focuser types are supported:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Absolute</emphasis>: Absolute Position Focusers such as RoboFocus, MoonLite, &etc;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Relative</emphasis>: Relative Position Focusers.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Simple Focusers</emphasis>: DC/PWM focusers with no position feedback.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ For absolute focusers, you can set the ticks count. To view a continuous feed of the camera, click the <guibutton>Framing</guibutton> button. An image shall be captured repeatedly according to the CCD settings in the CCD and Filter Wheel group. You can focus in and out by pressing the respective buttons, and each shall move by the step size indicated in the focus settings. For absolute and relative focusers, the step size is in units of <emphasis>ticks</emphasis> and for simple DC focusers, the step size is in <emphasis>milliseconds</emphasis>
+ </para>
+ <para>
+ To begin the autofocus process, simply click the <guibutton>Auto Focus</guibutton> button.
+ </para>
+ </sect3>
+
+ <sect3 id="focus-ccd-filter-wheel">
+ <title>CCD & Filter Wheel Group</title>
+
+ <screenshot>
+ <screeninfo>
+ Focus CCD & Filter Wheel Group
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="focus_ccdfw_group.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Focus CCD & Filter Wheel Group</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ You must specify the CCD and Filter Wheel (if any) to be used during the focusing process. You can <emphasis role="bold">lock</emphasis> a specific filter within the filter wheel to be utilized whenever the autofocus process is invoked. Usually, the user should select the Clear/Luminescence filter for this purpose so that Ekos always uses the same filter to perform the autofocus process. This locked filter is also used in the <link linkend="ekos-align">Alignment Module</link> whenever it performs any astrometry capture.
+ </para>
+ <para>
+ You may also select an <guilabel>Effect</guilabel> filter to enhance the image for preview purposes. It is highly advisable to turn off any effects during the focusing process as it may interfere with HFR calculations. For DSLRs cameras, you can change the ISO settings. You may reset the focusing subframe to full frame capture if you click the <guibutton>Reset</guibutton> button.
+ </para>
+ </sect3>
+
+ <sect3 id="focus-settings">
+ <title>Settings</title>
+
+ <screenshot>
+ <screeninfo>
+ Focus Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="focus_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Focus Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ You may need to adjust focus settings in order to achieve a successful and reliable autofocus process. The settings are retained between sessions.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Auto Star Select</emphasis>: Automatically select the best focus star from the image.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Subframe</emphasis>: Subframe around the focus star during the autofocus procedure. Enabling subframing can significantly speed up the focus process.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Dark Frame</emphasis>: Check this option to capture a dark frame if necessary and perform dark-frame subtraction. This option can be useful in noisy images.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Suspend Guiding</emphasis>: Suspend Guiding while autofocus in progress. If the focus process can disrupt the guide star (⪚ when using Integrated Guide Port IGP whereas the guider is physically attached to the primary CCD), then it is recommended to enable this option. When using Off-Axis guider, then this option is not necessary.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Box size</emphasis>: Sets the box size used to enclose the focus star. Increase if you have very large stars.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Max Travel</emphasis>: Maximum travel in ticks before the autofocus process aborts.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Step</emphasis>: <emphasis>Initial</emphasis> step size in ticks to cause a noticeable change in HFR value. For timer-based focuser, it is the initial time in milliseconds to move the focuser inward or outward.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Tolerance</emphasis>: The tolerance percentage values decides when the autofocus process stops in the <guilabel>Iterative</guilabel> algorithm. During the autofocus process, HFR values are recorded, and once the focuser is close to an optimal position, it starts measuring HFRs against the minimum recorded HFR in the sessions and stops whenever a measured HFR value is within % difference of the minimum recorded HFR. Decrease value to narrow optimal focus point solution radius. Increase to expand solution radius.
+ </para>
+ <warning>
+ <para>
+ Setting the value too low might result in a repetitive loop and would most likely result in a failed autofocus process.
+ </para>
+ </warning>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Threshold</emphasis>: Threshold percentage value is used for star detection using the <emphasis>Threshold<emphasis> detection algorithm. Increase to restrict the centroid to bright cores. Decrease to enclose fuzzy stars.</emphasis></emphasis></para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Algorithm</emphasis>: Select the autofocus process algorithm:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Iterative</emphasis>: Moves focuser by discreet steps initially decided by the step size. Once a curve slope is calculated, further step sizes are calculated to reach an optimal solution. The algorithm stops when the measured HFR is within percentage tolerance of the minimum HFR recorded in the procedure.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Polynomial</emphasis>: Starts with the iterative method. Upon crossing to the other side of the V-Curve, polynomial fitting coefficients along with possible minimum solution are calculated. This algorithm can be faster than a purely iterative approach given a good data set.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Frames</emphasis>: Number of average frames to capture. During each capture, an HFR is recorded. If the instantaneous HFR value is unreliable, you can average a number of frames to increase the signal to noise ratio.</para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Detection</emphasis>: Select star detection algorithm. Each algorithm has its strengths and weaknesses. It is recommended to keep the default value unless it fails to properly detect stars.</para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="focus-v-curve">
+ <title>V-Curve</title>
+
+ <screenshot>
+ <screeninfo>
+ Focus V-Curve
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="focus_vcurve.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Focus V-Curve</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ The V-shaped curve displays absolute position versus Half-Flux-Radius (HFR) values. The center of the V-curve is the optimal focus position. Once Ekos crosses from one side of the V-curve to the other, it backtracks and tries to find the optimal focus position. The final focus position is decided by which algorithm is selected.
+ </para>
+ <para>
+ When framing, the horizontal axis denotes the frame number. This is to aid you in the framing process as you can see how HFR changes between frames.
+ </para>
+ </sect3>
+
+ <sect3 id="focus-relative-profile">
+ <title>Relative Profile</title>
+
+ <screenshot>
+ <screeninfo>
+ Focus Relative Profile
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="focus_relative_profile.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Focus Relative Profile</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ The relative profile is a graph that displays the relative HFR values plotted against each other. Lower HFR values correspond to narrower shapes and vice-versa. The solid red curve is the profile of the current HFR value, while the dotted green curve is for the previous HFR value. Finally, the magenta curve denotes the first measured HFR and is displayed when the autofocus process concludes. This enables you to judge how well the autofocus process improved the relative focus quality.
+ </para>
+ </sect3>
+</sect2>
diff --git a/doc/ekos-guide.docbook b/doc/ekos-guide.docbook
new file mode 100644
index 000000000..ff1e4d6f9
--- /dev/null
+++ b/doc/ekos-guide.docbook
@@ -0,0 +1,337 @@
+<sect2 id="ekos-guide">
+ <title>Guide</title>
+ <indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Guide</tertiary>
+ </indexterm>
+ <screenshot>
+ <screeninfo>
+ Ekos Guide Module
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_guide.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos Guide Module</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <sect3 id="guide-Introduction">
+ <title>Introduction</title>
+ <para>
+ Ekos Guide Module enables autoguiding capability using either the powerful built-in guider, or at your option, external guiding via <ulink url="http://openphdguiding.org/">PHD2</ulink> or <ulink url="https://sourceforge.net/projects/linguider/">lin_guider</ulink>. Using the internal guiding, guider CCD frames are captured and sent to Ekos for analysis. Depending on the deviations of the guide star from its lock position, guiding pulses corrections are sent to your mount <guilabel>Via</guilabel> any device that supports ST4 ports. Alternatively, you may send the corrections to your mount <emphasis>directly</emphasis>, if supported by the mount driver. Most of the GUI options in the Guide Module are well documented so just hover your mouse over an item and a tooltip will popup with helpful information.
+ </para>
+ <para>
+ To perform guiding, you need to select a Guider CCD in Ekos Profile Setup. The telescope aperture and focal length must be set in the telescope driver. If the Guider CCD is attached to a separate Guide Scope, you must also set the Guide Scope's Focal Length and Aperture. You can set these values under the Options tab of the telescope driver or from the Mount module. Autoguiding is a two-step process: Calibration & Guiding.
+ </para>
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="315" contentwidth="560" fileref="https://www.youtube.com/embed/aza2fGIF7YE"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Guiding introduction</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+ <para>
+ During the two processes, you must set the following:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Guider</guilabel>: Select the Guider CCD.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Via</guilabel>: Selects which device receives the autoguiding correction pulses from Ekos. Usually, guider CCDs have an ST4 port. If you are using the guider's ST4 to autoguide your telescope, set the guider driver in the <guilabel>Via</guilabel> combo box. The guider CCD will receive the correction pulses from Ekos and will relay them to the mount via the ST4 port. Alternatively, some telescopes support pulse commands and you can select the telescope to be a receiver of the Ekos correction pulses.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Exposure</guilabel>: CCD Exposure in seconds.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Binning</guilabel>: CCD Binning.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Box</guilabel>: Size of the box enclosing the guide star. Select a suitable size that is neither too large or too small for the selected star.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Effects</guilabel>: Specify filter to be applied to the image to enhance it.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="guide-dark-frames">
+ <title>Dark Frames</title>
+ <para>
+ Dark frames are <emphasis>immensely</emphasis> helpful in reducing noises in your guide frames. It is highly recommended to take dark frames before you begin and calibration or guiding procedure. To take a dark frame, check the <guilabel>Dark</guilabel> checkbox and then click <guilabel>Capture</guilabel>. For the first time this is performed, Ekos will ask you about your camera shutter. If your camera does not have a shutter, then Ekos will warn you anytime you take a dark frame to cover your camera/telescope before proceeding with the capture. On the other hand, if the camera already includes a shutter, then Ekos will directly proceed with taking the dark frame. All dark frames are automatically saved to Ekos Dark Frame Library. By default, the Dark Library keeps reusing dark frames for 30 days after which it will capture new dark frames. This value is configurable and can be adjusted in <link linkend="ekos">Ekos settings</link> in the &kstars; settings dialog.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Ekos Dark frames library
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="dark_library.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos Dark frames library</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ It is recommended to take dark frames covering several binning and exposure values so that they may be reused transparently by Ekos whenever needed.
+ </para>
+ </sect3>
+
+ <sect3 id="guide-calibration">
+ <title>Calibration</title>
+
+ <screenshot>
+ <screeninfo>
+ Calibration Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="guide_calibration_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Calibration Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ In the calibration phase, you need to capture an image, select a guide star, and click <guibutton>Guide</guibutton> to begin the calibration process. If calibration was already completed successfully before, then the autoguiding process shall begin immediately, otherwise, it would start the calibration process. If <guilabel>Auto Star</guilabel> is checked, then you are only required to click capture and Ekos will automatically select the best-fit guide star in the image and continues the calibration process automatically. If <emphasis>Auto Calibration</emphasis> is disabled, Ekos will try to automatically highlight the best guide star in the field. You need to confirm or change the selection before you can start the calibration process. The calibration options are:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Pulse</guilabel>: The duration of pulses in milliseconds to be sent to the mount. This value should be large enough to cause a noticeable movement in the guide star. If you increase the value and you do not notice any movement of the guide star, then this suggests possible mount issues such as jamming or connection issues via the ST4 cable.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Two axis</guilabel>: Check if you want the calibration process calibration in both RA & DEC. If unchecked, the calibration is only performed in RA.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Auto Star</guilabel>: If checked, Ekos will attempt to select the best guide star in the frame and begins the calibration process automatically.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The reticle position is the guide star position selected by you (or by the auto selection) in the captured guider image. You should select a star that is not close to the edge. If the image is not clear, you may select different <guilabel>Effects</guilabel> to enhance it.
+ </para>
+ <para>
+ Ekos begins the calibration process by sending pulses to move the mount in RA and DEC. If the calibration process fails due to short drift, try increasing the pulse duration. To clear calibration, click the trash bin icon next to <guibutton>Guide</guibutton> button.
+ </para>
+ <warning>
+ <para>
+ Calibration can fail for a variety of reasons. To improve the chances of success, try the tips below.
+ </para>
+ </warning>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Better Polar Alignment</guilabel>: This is critical to the success of any astrophotography session. Perform a quick polar alignment with a polar scope (if available) or by using Ekos <ulink url="http://www.indilib.org/about/ekos/alignment-module.html#polaralignment">Polar Alignment procedure</ulink> in the Align module.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Set binning to 2x2</guilabel>: Binning improves SNR and is often very important to the success of the calibration and guiding procedures.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Prefer to use ST4 cable between guide-camera and mount over using mount pulse commands.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select different filter (⪚ High contrast) and see if that makes a difference to bring down the noise.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Smaller Square Size.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Take dark frames to reduce noise.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Play with DEC Proportional Gain or disable DEC control completely and see the difference.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Leave algorithm to the default value (<guimenuitem>Smart</guimenuitem>)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="guide-guiding">
+ <title>Guiding</title>
+
+ <screenshot>
+ <screeninfo>
+ Guide Settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="guide_guide_settings.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Guide Settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Once the calibration process is completed successfully, the guiding shall begin automatically hereafter. The guiding performance is displayed in the Drift Graphics region where <guilabel>Green</guilabel> reflects deviations in RA and <guilabel>Blue</guilabel> deviations in DEC. The colors of the RA/DE lines can be changed in &kstars; color scheme in &kstars; settings dialog. The vertical axis denotes the deviation in arcsecs from the guide star central position and the horizontal axis denotes time. You can hover over the line to get the exact deviation at this particular point in time. Furthermore, you can also zoom and drag/pan the graph to inspect a specific region of the graph.
+ </para>
+ <para>
+ Ekos can utilize multiple algorithms to determine the center of mass of the guide star. By default, the <emphasis>smart</emphasis> algorithm is suited best for most situation. The <emphasis>fast</emphasis> algorithm is based on HFR calculations. You can try switching guiding algorithms if Ekos cannot keep of the guide star within the guiding square properly.
+ </para>
+ <para>
+ The info region displays information on the telescope & FOV, in addition to the deviations from the guide star along with the correction pulses sent to the mount. The RMS value for each axis is displayed along with the total RMS value in arcsecs. The internal guider employs <ulink url="https://en.wikipedia.org/wiki/PID_controller">PID controller</ulink> to correct the mount tracking. Currently, the <emphasis>only</emphasis> the proportional and integral gains are utilized within the algorithm, so adjusting it should affect the length of the generated pulses sent to the mount in milliseconds.
+ </para>
+ <para>
+ To enable automatic dithering between frames, make sure to check the <guilabel>Dither</guilabel> checkbox. By default, Ekos should dither (&ie; move) the guiding box by up to 3 pixels after each frame captured in Ekos Capture Module. The motion duration and direction are randomized. Since the guiding performance can oscillate immediately after dithering, you can set the appropriate <guilabel>Settle</guilabel> duration to wait after dither is complete before resuming the capture process. In rare cases where the dithering process can get stuck in an endless loop, set the appropriate <guilabel>Timeout</guilabel> to abort the process. But even if dithering fails, you can select whether this failure should terminate the autoguiding process or not. Toggle <guilabel>Dither Failure Aborts Autoguide</guilabel> to select the desired behavior.
+ </para>
+ <para>
+ Non-guide dithering is also supported. This is useful when no guide camera is available or when performing short exposures. In this case, the mount can be commanded to dither in a random direction for up to the pulse specified in the <guilabel>Non-Guide Dither Pulse</guilabel> option.
+ </para>
+ <para>
+ Ekos supports multiple guiding methods: Internal, PHD2, and LinGuider. You need to select the desired guider in your Ekos equipment profile:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Internal Guider</guilabel>: Use Ekos internal guider. This is the default and recommended option.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>PHD2</guilabel>: Use PHD2 as the external guider. If selected, specify the host and port of the PHD2. Leave to default values if Ekos and PHD2 are running on the same machine.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>LinGuider</guilabel>: Use LinGuider as the external guider. If selected, specify the host and port of the LinGuider. Leave to default values if Ekos and LinGuider are running on the same machine.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <screenshot>
+ <screeninfo>
+ Guiding Direction Control
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_profile_guider_select.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Guiding Direction Control</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </sect3>
+
+ <sect3 id="guide-direction-control">
+ <title>Guiding Direction Control</title>
+ <para>
+ You can fine-tune the guiding performance in the Control Section. The autoguide process works like a <ulink url="https://en.wikipedia.org/wiki/PID_controller">PID controller</ulink> when sending correction commands to the mount. You can alter the Proportional and Integral gains to improve the guiding performance if necessary. By default, guiding corrective pulses are sent to both mount axis in all directions: positive and negative. You can fine-tune control by selecting which axis shall receive corrective guiding pulses and within each axis, you can indicate which direction <guilabel>(Positive) +</guilabel> or <guilabel>Negative (-)</guilabel> receives the guiding pulses. For example, for the Declination axis, the <guilabel>+</guilabel> direction is North and <guilabel>-</guilabel> is South.
+ </para>
+ </sect3>
+
+ <sect3 id="guide-guiding-rate">
+ <title>Guiding Rate</title>
+ <para>
+ Each mount has a particular guiding rate in (x15"/sec) and usually ranges from 0.1x, to 1.0x with 0.5x being a common value used by many mounts. The default guiding rate is 0.5x sidereal, which is equivalent to a proportional gain of 133.33. Therefore, set the guiding rate value to whatever value used by your mount, and Ekos shall display the <emphasis>recommended</emphasis> proportional gain value that you may set in the proportional gain field under the Control Parameters. Setting this value <emphasis>does not</emphasis> change your mount guiding rate! You must change your mount guiding rate either via the INDI driver, if supported, or via the hand controller.
+ </para>
+ </sect3>
+
+ <sect3 id="guide-drift-graphics">
+ <title>Drift Graphics</title>
+
+ <screenshot>
+ <screeninfo>
+ Drift Graphics
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="guide_drift_graphics.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Drift Graphics</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ The drift graphics is a very useful tool to monitor the guiding performance. It is a 2D plot of guiding <emphasis>deviations</emphasis> and <emphasis>corrections</emphasis>. By default, only the guiding deviations in RA and DE are displayed. The horizontal axis is the time in seconds since the autoguiding process was started while the vertical axis plots the guiding drift/deviation in arcsecs for each axis. Guiding corrections (pulses) can also be plotted in the same graph and you can enable them by checking the <guilabel>Corr</guilabel> checkbox below each Axis. The corrections are plotted as shaded areas in the background with the same color as that of the axis.
+ </para>
+ <para>
+ You can pan and zoom the plot, and when hovering the mouse over the graph, a tooltip is displayed containing information about this specific point in time. It contains the guiding drift and any corrections made, in addition to the local time, this event was recorded. A vertical slider to the right of the image can be used to adjust the height of the secondary Y-axis for pulses corrections.</para>
+ <para>
+ The <guilabel>Trace</guilabel> horizontal slider at the bottom can be used to scroll through the guide history. Alternatively, you can click the <guilabel>Max</guilabel> checkbox to lock the graph onto the latest point so that the drift graphics autoscrolls. The buttons to the right of the slider are used for autoscaling the graphs, exporting the guide data to a CSV file, clearing all the guide data, and for scaling the target in the Drift Plot. Furthermore, the guide graph includes a label to indicate when a dither occurred so the user knows guiding was not bad at those points.
+ </para>
+ <para>
+ The colors of each axis can be customized in <link linkend="colors">&kstars; Settings color scheme</link>.
+ </para>
+ </sect3>
+
+ <sect3 id="guide-drift-plot">
+ <title>Drift Plot</title>
+ <para>
+ A bulls-eye scatter plot can be used to gauge the <emphasis>accuracy</emphasis> of the overall guiding performance. It is composed of three concentric rings of varying radii with the central green ring having a default radius of 2 arcsecs. The last RMS value is plotted as <inlinemediaobject><imageobject><imagedata fileref="add-circle.png" format="PNG"/></imageobject></inlinemediaobject> with its color reflecting which concentric ring it falls within. You can change the radius of the innermost green circle by adjusting the drift plot accuracy.
+ </para>
+ </sect3>
+
+ <sect3 id="guide-phd2-support">
+ <title>PHD2 Support</title>
+ <para>
+ You can opt to select external PHD2 application to perform guiding instead of the built-in guider.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Ekos Guide PHD2 settings
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_guide_phd2.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos Guide PHD2 settings</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+ <para>
+ If PHD2 is selected, the <emphasis>Connect</emphasis> and <emphasis>Disconnect</emphasis> buttons are enabled to allow you to establish a connection with the PHD2 server. You can control PHD2 exposure and DEC guide settings. When clicking <guibutton>Guide</guibutton>, PHD2 should perform all the required actions to start the guiding process. PHD2 <guilabel>must</guilabel> be started and configured <emphasis>before</emphasis> Ekos.
+ </para>
+ <para>
+ After launching PHD2, select your INDI equipment and set their options. From Ekos, connect to PHD2 by clicking <guilabel>Connect</guilabel> button. On startup, Ekos will attempt to automatically connect to PHD2. Once the connection is established, you may begin the guiding immediately by click on the <guibutton>Guide</guibutton> button. PHD2 shall perform calibration if necessary. If dithering is selected, PHD2 shall be commanded to dither given the offset pixels indicated and once guiding is settled and stable, the capture process in Ekos shall resume.
+ </para>
+ <note>
+ <para>
+ Ekos saves a CSV guide log data that can be useful for analysis of the mount's performance under <filename>~/.local/share/kstars/guide_log.txt</filename>. This log is only available when using the built-in guider.
+ </para>
+ </note>
+ </sect3>
+</sect2>
diff --git a/doc/ekos-logs.docbook b/doc/ekos-logs.docbook
new file mode 100644
index 000000000..aa274d6a9
--- /dev/null
+++ b/doc/ekos-logs.docbook
@@ -0,0 +1,24 @@
+<sect2 id="ekos-logs">
+ <title>Logs</title>
+ <indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Logs</tertiary>
+ </indexterm>
+ <para>
+ Logging is a very important tool in order to diagnose any issues with either INDI drivers or Ekos. Before submitting any support request, the log must be attached in order to help diagnose the exact issue. Depending on the exact problem, you may need to enable logging for the feature or drivers that exhibit issues. Enabling logging for everything is not recommended as it will produce too much data that would be useful to diagnose the issue and could result in missing the root cause all other. So only enable the necessary logs.
+ </para>
+ <para>
+ The following short video explains how to use the Logging feature to submit logs.
+ </para>
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="450" contentwidth="800" fileref="https://www.stellarmate.com/images/videos/indi_logs_guide.mp4"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Logging feature</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+</sect2>
diff --git a/doc/ekos-profile-editor.docbook b/doc/ekos-profile-editor.docbook
new file mode 100644
index 000000000..bfd1ff7cb
--- /dev/null
+++ b/doc/ekos-profile-editor.docbook
@@ -0,0 +1,82 @@
+<sect2 id="ekos-profile-editor">
+ <title>Profile Editor</title>
+ <indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Profile Editor</tertiary>
+ </indexterm>
+ <screenshot>
+ <screeninfo>
+ Profile Editor
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="profile_editor.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Profile Editor</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <variablelist>
+ <varlistentry>
+ <term>Profiles</term>
+ <listitem>
+ <para>
+ You can define profiles for your equipment and their connection mode using the <guilabel>Profile Editor</guilabel>. Ekos comes pre-installed with the <guimenuitem>Simulators</guimenuitem> profile which can be used to start simulator devices for demonstration purposes:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Connection Mode</guilabel>: Ekos can be started either locally or remotely. Local mode is when Ekos is running in the same machine as INDI server, &ie; all the devices are connected directly to the machine. If you run INDI server on a remote machine (for example, on a Raspberry PI), you need to set the INDI server host and port.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Auto Connect</guilabel>: Check this option to enable automatic connection to all your devices after INDI server is started. If unchecked, INDI devices are created but not automatically connected. This is useful when you want to make changes to the driver (⪚ change baud rate or IP address or any other settings) <emphasis>before</emphasis> you connect to it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Site Info</guilabel>: Optionally, you can check the <guilabel>Site Info</guilabel> checkbox and Ekos will load the <emphasis role="bold">current</emphasis> city and timezone whenever is Ekos is started with this profile. This can be useful when connecting to the remote geographic site so that Ekos is in sync location and time wise.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Guiding</guilabel>: Select which Guide application you want to use for guiding. By default, the Ekos internal Guide Module is utilized. External guiders include PHD2 and LinGuider.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>INDI Web Manager</guilabel>: StellarMate Web Manager is a web-based tool to start and stop INDI drivers. You should always check this option when connecting remotely to a StellarMate unit.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Device Selection</guilabel>: Select your devices from each category. Please note that if you have a CCD with a guide head, you can leave the guider drop-down menu <emphasis>blank</emphasis> as Ekos will auto-detect the guide head from the CCD camera. Similarly, if your CCD includes embedded filter wheel support, then you do <emphasis>not</emphasis> need to specify the filter wheel device in the filter drop-down menu.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Start & Stop INDI</term>
+ <listitem>
+ <para>
+ Start and Stop INDI services. Once INDI server is established, INDI Control Panel will be displayed. Here you can change some driver options such as which port the device is connected to &etc;
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Connect & Disconnect Devices</term>
+ <listitem>
+ <para>
+ Connect to INDI server. Based on the devices connected, Ekos modules (CCD, Focus, Guide...etc) will be established and available to use.
+ </para>
+ <para>
+ Once you are ready, click <guibutton>Start INDI</guibutton> to establish INDI server and connection to your equipment. Ekos shall create the various module icons (Mount, Capture, Focus, &etc;) as the connection is established with the device.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</sect2>
diff --git a/doc/ekos-profile-wizard.docbook b/doc/ekos-profile-wizard.docbook
new file mode 100644
index 000000000..c591a507f
--- /dev/null
+++ b/doc/ekos-profile-wizard.docbook
@@ -0,0 +1,123 @@
+<sect2 id="ekos-profile-wizard">
+ <title>Profile Wizard</title>
+ <indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Profile Wizard</tertiary>
+ </indexterm>
+ <para>
+ The Profile Wizard is a handy tool to setup your equipment for the first time. It should popup automatically the first time you run &kstars;. Follow the guided instructions to setup your first equipment profile.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Greeting Page</term>
+ <listitem>
+ <screenshot>
+ <screeninfo>
+ Profile Wizard Welcome
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="profile_wizard_welcome.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Profile Wizard Welcome</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ The first greeting screen contains some links to learn more about Ekos & INDI. Click <guibutton>Next</guibutton> to continue.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Equipment Location Page</term>
+ <listitem>
+ <para>
+ Next, you will be presented with the equipment location page. Your selection depends on where your equipment is connected to:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Equipment is attached to your PC</guilabel>: Select this option if Ekos is running on your StellarMate (via HDMI or VNC), PC (&Windows;/&Linux;) or &MacOS;.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Equipment is attached to a remote computer</guilabel>: Select this option if Ekos is running on your PC (&Windows;/&Linux;) or &MacOS;, and your equipment is connected to a remote computer.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Equipment is attached to StellarMate</guilabel>: Select this option if Ekos is running on your PC (&Windows;/&Linux;) or &MacOS;, and your equipment is connected to StellarMate.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <screenshot>
+ <screeninfo>
+ Equipment location page
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="profile_wizard_select.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Equipment location page</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Click next to continue.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Remote Connection Page</term>
+ <listitem>
+ <para>
+ In case selected the 2nd option in the last step, you shall be presented with the Remote Connect Page, here you will enter the hostname or IP address of the StellarMate unit. You can get the hostname from the StellarMate mobile App. Alternatively, you can construct the hostname from StellarMate HotSpot SSID. You should see the SSID when you search for WiFi networks nearby. For example, suppose the SSID is <replaceable>stellarmate</replaceable>. The hostname should be <emphasis><replaceable>stellarmate</replaceable>.local</emphasis>. That is, if you remove the underscore, and append <emphasis>.local</emphasis>, then you will get the unit hostname. You can always use the StellarMate App to change the unit default hostname to the name of your choice.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Profile Wizard Remote page
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="profile_wizard_remote.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Profile Wizard Remote page</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ For the INDI Manager question, always select <emphasis role="bold">Yes</emphasis> since StellarMate Web Manager is running by default on the unit. Click <guibutton>Next</guibutton> to continue.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Profile Creation Page</term>
+ <listitem>
+ <para>
+ Now you get to name your equipment profile. Afterwards select which guider application to use. The <guilabel>Internal Guider</guilabel> is the only officially supported selection in StellarMate. You may opt to select <guimenuitem>PHD2/LinGuider</guimenuitem> but the details are out of the scope of this documentation. If additional services are desired, check the ones you want to run.
+ </para>
+ <screenshot>
+ <screeninfo>
+ The final page of Profile Wizard
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="profile_wizard_done.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>The final page of Profile Wizard</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+<para>
+ In the example above, we select Remote Astrometry, WatchDog, and SkySafari drivers. The detailed explanations for each is provided in the tooltip when you over them. Once done, click <guibutton>Create Profile</guibutton> button. You should now be presented with the Profile Editor.
+</para>
+</sect2>
diff --git a/doc/ekos-scheduler.docbook b/doc/ekos-scheduler.docbook
new file mode 100644
index 000000000..2f6bd78f9
--- /dev/null
+++ b/doc/ekos-scheduler.docbook
@@ -0,0 +1,344 @@
+<sect2 id="ekos-scheduler">
+ <title>Scheduler</title>
+ <indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Scheduler</tertiary>
+ </indexterm>
+ <screenshot>
+ <screeninfo>
+ Ekos Scheduler Module
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_scheduler.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos Scheduler Module</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <sect3 id="ekos-scheduler-introduction">
+ <title>Introduction</title>
+ <para>
+ Ekos Scheduler is an indispensable arsenal in building your robotic observatory. A Robotic observatory is an observatory composed of several subsystems that are orchestrated together to achieve a set of scientific objectives without human intervention. It is the only Ekos module that does not require Ekos to be started as it is utilized to <emphasis>start</emphasis> and <emphasis>stop</emphasis> Ekos. It is designed to be straightforward and intuitive. However, the scheduler should only be used after you mastered Ekos and knows all the quirks of your equipment. Since the complete process is automated, including focus, guiding, and meridian flip. All equipment should be thoroughly used with Ekos and all their parameters and settings adjusted to achieve the best result.
+ </para>
+ <para>
+ With Ekos, the user can utilize the powerful sequence queue to image batches of images for a particular target. In simple setups, the user is expected to focus the CCD, align the mount, frame the target, and start guiding before initiating the capture process. For more complex observatory environments, there are usually predefined custom procedures to be executed to prepare the observatory for imaging, and another set of procedures on shutdown. The user may plan to image one or more targets during the night and expects data to be ready by morning. In &kstars;, tools such as the <link linkend="tool-obsplanner">Observation Planner</link> and <link linkend="tool-whatsup">What's up Tonight</link> help the user in selecting candidates for imaging. After selecting the desired candidates, the user can add them to the Ekos Scheduler list for evaluation. The user may also add the targets directly in Ekos scheduler or select a FITS file of a previous image.
+ </para>
+ </sect3>
+
+ <sect3 id="ekos-scheduler-settings">
+ <title>Settings</title>
+ <para>
+ Ekos Scheduler provides a simple interface to aid the user in setting the conditions and constraints required for an observation job. Each observation job is composed of the following:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Target name and coordinates</guilabel>: Select target from the Find Dialog or Add it from Observation Planner. You can also enter a custom name.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Optional FITS file</guilabel>: If a FITS file is specified, the astrometry solver shall solve the file and use the central RA/DEC as the target coordinates.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Sequence File</guilabel>: The sequence file is constructed in the Ekos <link linkend="ekos-capture">Capture Module</link>. It contains the number of images to capture, filters, temperature settings, prefixes, download directory, &etc;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Priority</guilabel>: Set job priority in the range of 1 to 20 where 1 designates the highest priority and 20 the lowest priority. Priority is applied in calculating the weight used to select the next target to image.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Profile</guilabel>: Select which equipment profile to utilize when starting Ekos. If Ekos & INDI are already started and online, this selection is ignored.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Steps</guilabel>: The user selects which Ekos modules should be utilized in the observation job execution workflow.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Startup Conditions</guilabel>: Conditions that must be met <emphasis role="bold">before</emphasis> the observation job is started. Currently, the user may select to start as soon as possible <guimenuitem>Now</guimenuitem>, or when the target is near or past culmination, or at a specific time.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Constraints</guilabel>: Constraints are conditions that must be met <emphasis role="bold">at all times</emphasis> during the observation job execution process. These include minimum target altitude, minimum moon separation, twilight observation, and weather monitoring.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Completion Conditions</guilabel>: Conditions that trigger completion of the observation job. The default selection is to simply mark the observation job as complete once the sequence process is complete. Additional conditions enable the user to repeat the sequence process indefinitely or up until a specific time.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ You must select the <guilabel>Target</guilabel> and <guilabel>Sequence</guilabel> before you can add a job to the Scheduler. When the scheduler starts, it evaluates all jobs in accord to the conditions and constraints specified and attempts to select the best job to execute. Selection of the job depends on a simple heuristic algorithm that scores each job given the conditions and constraints, each of which is weighted accordingly. If two targets have identical conditions and constraints, usually the higher priority target followed by higher altitude target is selected for execution. If no candidates are available at the current time, the scheduler goes into sleep mode and wakes up when the next job is ready for execution.
+ </para>
+ <screenshot>
+ <screeninfo>
+ Scheduler + Planner
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="scheduler_planner.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Scheduler + Planner</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ The description above only tackles the <emphasis role="bold">Data Acquisition</emphasis> stage of the observatory workflow. The overall procedure typically utilized in an observatory can be summarized in three primary stages:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Startup
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Data Acquisition (including preprocessing and storage)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shutdown
+ </para>
+ </listitem>
+ </orderedlist>
+ </sect3>
+
+ <sect3 id="ekos-scheduler-startup-procedure">
+ <title>Startup Procedure</title>
+ <para>
+ Startup procedure is unique to each observatory but may include:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Turning on power to equipment
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Running safety/sanity checks
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Checking weather conditions
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Turning off light
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fan/Light control
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Unparking dome
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Unparking mount
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ &etc;
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Ekos Scheduler only initiates the startup procedure once the startup time for the first observation job is close (default <emphasis>lead</emphasis> time is 5 minutes before <emphasis>startup</emphasis> time). Once the startup procedure is completed successfully, the scheduler picks the observation job target and starts the sequence process. If a startup script is specified, it shall be executed first.
+ </para>
+ </sect3>
+
+ <sect3 id="ekos-scheduler-data-acquisition">
+ <title>Data Acquisition</title>
+ <para>
+ Depending the on the user selection, the typical workflow proceeds as follows:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Slew mount to target. If a FITS file was specified, it first solves the files and slew to the file coordinates.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Auto-focus target. The autofocus process automatically selects the best star in the frame and runs the autofocus algorithm against it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Perform plate solving, sync mount, and slew to target coordinates.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Perform post-alignment focusing since the frame might have moved during the plate solving process.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Perform calibration and start auto-guiding: The calibration process automatically selects the best guide star, performs calibration, and starts the autoguide process.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Load the sequence file in the <link linkend="ekos-capture">Capture module</link> and start the imaging process.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="ekos-scheduler-shutdown">
+ <title>Shutdown</title>
+ <para>
+ Once the observation job is completed successfully, the scheduler selects the next target. If the next target scheduled time is not due yet, the mount is parked until the target is ready. Furthermore, if the next scheduled target is not due for a user-configurable time limit, the scheduler performs a <emphasis>preemptive</emphasis> shutdown to preserve resources and performs the startup procedure again when the target is due.
+ </para>
+ <para>
+ If an unrecoverable error occurs, the observatory initiates shutdown procedure. If there is a shutdown script, it will be executed last.
+ </para>
+ <para>
+ The following video demonstrates an earlier version of the scheduler, but the basic principles still apply today:
+ </para>
+ <mediaobject>
+ <videoobject>
+ <videodata contentdepth="315" contentwidth="560" fileref="https://www.youtube.com/embed/v8vIXD1kois"/>
+ </videoobject>
+ <caption>
+ <para>
+ <phrase>Ekos Scheduler</phrase>
+ </para>
+ </caption>
+ </mediaobject>
+ </sect3>
+
+ <sect3 id="ekos-scheduler-weather-monitoring">
+ <title>Weather Monitoring</title>
+ <para>
+ Another critical feature of any remotely operated robotic observatory is weather monitoring. For weather updates, Ekos relies on the selected INDI weather driver to continuously monitor the weather conditions. For simplicity sake, the weather conditions can be summed in three states:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Ok</emphasis>: Weather conditions are clear and optimal for imaging.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Warning</emphasis>: Weather conditions are not clear, seeing is subpar, or partially obstructed and not suitable for imaging. Any further imaging process is suspended until the weather improves. Warning weather status does not pose any danger to the observatory equipment so the observatory is kept operational. The exact behavior to take under Warning status can be configured.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Alert</emphasis>: Weather conditions are detrimental to the observatory safety and shutdown must be initiated as soon as possible.
+ </para>
+ </listitem>
+ </orderedlist>
+ </sect3>
+
+ <sect3 id="ekos-scheduler-startup-and-shutdown-scripts">
+ <title>Startup & Shutdown Scripts</title>
+ <para>
+ Due to the uniqueness of each observatory, Ekos enables the user to select startup and shutdown scripts. The scripts take care of any necessary procedures that must take place on startup and shutdown stages. On startup, Ekos executes the startup scripts and only proceeds to the remainder of the startup procedure (unpark dome/unpark mount) if the script completes successfully. Conversely, the shutdown procedure begins with parking the mount & dome before executing the shutdown script as the final procedure.
+ </para>
+ <para>
+ Startup and shutdown scripts can be written any language that can be executed on the local machine. It must return 0 to report success, any other exist value is considered an error indicator. The script's standard output is also directed to Ekos logger window. The following is an sample demo startup script in Python:
+ </para>
+ <programlisting language="python">
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import os
+import time
+import sys
+
+print "Turning on observatory equipment..."
+sys.stdout.flush()
+
+time.sleep(5)
+
+print "Checking safety switches..."
+sys.stdout.flush()
+
+time.sleep(5)
+
+print "All systems are GO"
+sys.stdout.flush()
+
+exit(0)
+ </programlisting>
+ <para>
+ The startup and shutdown scripts must be <emphasis>executable</emphasis> in order for Ekos to invoke them (⪚ use <userinput>chmod +x startup_script.py</userinput> to mark the script as executable). Ekos Scheduler enables truly simple robotic operation without the need of any human intervention in any step of the process. Without human presence, it becomes increasingly critical to gracefully recover from failures in any stage of the observation run. Using &plasma; notifications, the user can configure audible alarms and email notifications for the various events in the scheduler.
+ </para>
+ </sect3>
+
+ <sect3 id="ekos-scheduler-mosaic-wizard">
+ <title>Mosaic Wizard</title>
+ <screenshot>
+ <screeninfo>
+ Mosaic Wizard
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="mosaic_wizard.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Mosaic Wizard</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Hubble-like super wide field images of <ulink url="http://billsnyderastrophotography.com/?page_id=3275">galaxies</ulink> and nebulae are truly awe-inspiring, and while it takes great skills to obtain such images and process them; many notable names in the field of astrophotography employ gear that is not <emphasis>vastly</emphasis> different from yours or mine. I emphasize <emphasis>vastly</emphasis> because some do indeed have impressive equipment and dedicated observatories worth tens of the thousands of dollars. Nevertheless, many amateurs can obtain stellar wide-field images by combining smaller images into a single grand mosaic.
+ </para>
+ <para>
+ We are often limited by our camera+telescope Field of View (FOV). By increasing FOV by means of a focal reducer or a shorter tube, we gain a larger sky coverage at the expense of spatial resolution. At the same time, many attractive wide-field targets span multiple FOVs across the sky. Without any changes to your astrophotography gear, it is possible to create a super mosaic image <emphasis>stitched</emphasis> together from several smaller images. There are two major steps to accomplish a super mosaic image:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Capture multiple images spanning the target with some overlap between images. The overlap is necessary to enable the processing software from aligning and joining the sub-images.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Process the images and <emphasis>stitch</emphasis> them into a super mosaic image.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ The 2nd step is handled by image processing applications such as <ulink url="https://pixinsight.com">PixInsight</ulink>, among others, and will not be the topic of discussion here. The first step can be accomplished in Ekos Scheduler where it creates a mosaic suitable for your equipment and in accordance with the desired field of view. Not only Ekos creates the mosaic panels for your target, but it also constructs the corresponding observatory jobs required to capture all the images. This greatly facilitates the logistics of capturing many images with different filters and calibration frames across a wide area of the sky.
+ </para>
+ <para>
+ Before starting the <guilabel>Mosaic Job Creator</guilabel> in Ekos Scheduler, you need to select a target and a sequence file. The Sequence File contains all the information necessary to capture an image including exposure time, filters, temperature setting, &etc; Start the Mosaic Job Creator by clicking on the icon next to the <guibutton>Find</guibutton> button in Ekos Module.
+ </para>
+ <para>
+ On first use, you need to enter your equipment settings including your telescope focal length in addition to camera's width, height, and pixel dimensions. Finally, you need to enter the rotation of the camera with respect to north or the position angle. If you don't know this value, start Ekos and slew to your desired target then use the Align module to solve the image and obtain the position angle.
+ </para>
+ <para>
+ Next, enter the desired number of horizontal and vertical panels (⪚ 2x2, 3x3, &etc;) and then click <guibutton>Update</guibutton>. The target FOV shall be calculated given the number of panels and your camera's FOV and the mosaic overlap shall be displayed. By default, the percentage of the overlap among images is 5%, but you can change this value to your desired value. You can also move the complete mosaic structure around to fine tune the position of the mosaic panels. When satisfied, click <guibutton>Create Jobs</guibutton> and Ekos shall create an observation job and a corresponding customized sequence file for each panel. All the jobs shall be saved to an Ekos Scheduler List (<filename role="extension">.esl</filename>) file that you can load on any suitable observing night and it will pick off where you left. Before starting the <guilabel>Mosaic Job Creator</guilabel>, check that all the observation job conditions, constraints, and startup/shutdown procedures are as per your requirements since these settings shall be copied to all the jobs generated by the Mosaic tool.
+ </para>
+ <para>
+ With Ekos Scheduler, multi-night imaging is greatly facilitated and creating super mosaics has never been so easy.
+ </para>
+ </sect3>
+</sect2>
diff --git a/doc/ekos-setup.docbook b/doc/ekos-setup.docbook
new file mode 100644
index 000000000..b91a9410d
--- /dev/null
+++ b/doc/ekos-setup.docbook
@@ -0,0 +1,40 @@
+<sect2 id="ekos-setup">
+ <title>Ekos Setup</title>
+<indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Setup</tertiary>
+</indexterm>
+<screenshot>
+ <screeninfo>
+ Ekos Summary
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_summary.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos Summary</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>
+ <emphasis role="bold">Ekos</emphasis> is a part of <ulink url="http://edu.kde.org/kstars">&kstars;</ulink>. &kstars;/Ekos is already included with your StellarMate gadget. It is also <ulink url="https://www.stellarmate.com/component/jdownloads/category/2-ekos.html?Itemid=507">available for &Linux;, &MacOS;, and &Windows;</ulink> if you want to install on your primary machine. After you run &kstars; on your PC or on StellarMate (Either directly via HDMI or via <link linkend="ekos-tutorials-viewer">VNC</link>), Ekos can be accessed from the <guimenu>Tools</guimenu> menu or via the <guiicon>Ekos</guiicon> on the main toolbar, or by a keyboard shortcut (<keycombo>&Ctrl; <keycap>K</keycap></keycombo>). In addition to the Ekos window, &kstars; provides a more detailed INDI Control Panel where you can directly set and control the device parameters.
+</para>
+<para>
+ When running Ekos, it is <emphasis>not</emphasis> necessary to start INDI Server via StellarMate Web Manager as Ekos manages that transparently.
+</para>
+<screenshot>
+ <screeninfo>
+ &kstars; Main Window
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="kstars_annotation.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>&kstars; Main Window</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+</sect2>
diff --git a/doc/ekos-tutorials.docbook b/doc/ekos-tutorials.docbook
new file mode 100644
index 000000000..f1ad0fc37
--- /dev/null
+++ b/doc/ekos-tutorials.docbook
@@ -0,0 +1,26 @@
+<sect2 id="ekos-tutorials">
+ <title>Ekos Tutorials</title>
+<indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>Tutorials</tertiary>
+</indexterm>
+<sect3 id="ekos-tutorials-viewer">
+ <title>Viewer</title>
+ <para>
+ StellarMate is shipped with a VNC Server. This enables you to access the whole StellarMate desktop remotely. To connect to VNC, you can either use a Desktop/Mobile VNC Client, or simply via any browser.
+ </para>
+ <para>
+ The VNC address is: <userinput>http://<replaceable>stellarmate_hostname</replaceable>:6080/vnc.html</userinput>
+ </para>
+ <para>
+ Where <replaceable>stellarmate_hostname</replaceable> is the actual hostname (or IP address) of your unit and 6080 is the port. If you do not know the unit hostname, you can find the hostname in your StellarMate App.
+ </para>
+ <para>
+ You can use <ulink url="https://www.realvnc.com/download/viewer/">Real VNC</ulink> which is available on all platforms to access stellarmate.
+ </para>
+ <para>
+ Once you access StellarMate, you can use it like any full-fledged computer. The default username is <userinput>stellarmate</userinput> and the default password is <userinput>smate</userinput>.
+ </para>
+</sect3>
+</sect2>
diff --git a/doc/ekos-user-interface.docbook b/doc/ekos-user-interface.docbook
new file mode 100644
index 000000000..d6fbe5cf1
--- /dev/null
+++ b/doc/ekos-user-interface.docbook
@@ -0,0 +1,119 @@
+<sect2>
+ <title>User Interface</title>
+ <indexterm>
+ <primary>Tools</primary>
+ <secondary>Ekos</secondary>
+ <tertiary>User Interface</tertiary>
+ </indexterm>
+ <para>
+ Ekos Astrophotography Tool is organized into several <emphasis>Modules</emphasis>. A module is a set of functions and tasks for a particular step in astrophotography and/or data acquisition. Currently, the following modules are included with Ekos:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Setup & Summary Module
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Scheduler Module
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Capture Module
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Focus Module
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Alignment Module
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Guide Module
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Mount Module
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Each module has its own tab and icon in the graphical user interface as illustrated in the screenshot below:</para>
+ <screenshot>
+ <screeninfo>
+ Ekos summary cheatsheet
+ </screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ekos_summary_cheatsheet.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Ekos summary cheatsheet</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <variablelist>
+ <varlistentry>
+ <term>Summary & Setup Module</term>
+ <listitem>
+ <para>
+ As its name suggests, this is where you will create and manage your equipment profile, and connect to your devices. It also provides a summary view where the capture progress along with the focus & guide operations is displayed in a compact format to convey the most important information relevant to the user.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Scheduler Module</term>
+ <listitem>
+ <para>
+ After mastering Ekos, users are encouraged to learn how to use the Scheduler module since it facilitates the complete observation process greatly. It enables you to select multiple targets, specify which conditions and requirements to be met, and what frames are required for capture. Afterwards the scheduler intelligently calculates the best observation time for each object and then proceed to control the complete observatory from startup to shutdown.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Capture Module</term>
+ <listitem>
+ <para>
+ This is the primary module for camera & filter wheel control. Create imaging sequences, capture previews, and watch video streams. It supports rotator control and can automatically capture flat frames in a number of scenarios.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Focus Module</term>
+ <listitem>
+ <para>
+ Measure the sharpness of your images in the focus module by calculating Half-Flux-Radius. The lower the HFR, the sharper the image becomes. You can run the focus module with or without a focuser. With an electronic focuser, you can run an autofocus operation where Ekos iterates and calculates the optical focus position.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Guide Module</term>
+ <listitem>
+ <para>
+ To achieve long exposure astrophotography, guiding is necessary to ensure the image is locked and stabilized for the complete duration of the exposure duration. Deviations from the frame with time can lead to blurry images and star trails. In the guide module, it can automatically select a suitable guide star and then lock the mount to always keep that star in its position. If the guide module detects any deviation from this locked position, it sends correction pulses to the mount to bring it back to the original position.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Mount Module</term>
+ <listitem>
+ <para>
+ Mount control can be either done via the Sky Map interactively or via the Mount Control Panel in the mount module. Configure telescope properties (focal length & aperture) for both your primary imaging telescope and guide scope. However, it is recommended to select the telescopes in the equipment profile and not change the values directly in the mount module.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</sect2>
diff --git a/doc/ekos.docbook b/doc/ekos.docbook
new file mode 100644
index 000000000..48f598b27
--- /dev/null
+++ b/doc/ekos.docbook
@@ -0,0 +1,143 @@
+<sect1 id="tool-ekos">
+<title>Ekos</title>
+<indexterm><primary>Tools</primary>
+<secondary>Ekos</secondary>
+</indexterm>
+
+<para>
+ <emphasis role="bold">Ekos</emphasis> is an advanced cross-platform (&Windows;, OSX, &Linux;) observatory control and automation tool with a particular focus on Astrophotography. It is based on a modular extensible framework to perform common astrophotography tasks. This includes highly accurate GOTOs using astrometry solver, ability to measure <emphasis>and</emphasis> correct polar alignment errors, auto-focus & auto-guide capabilities, and capture of single or stack of images with filter wheel support. Ekos is shipped with &kstars;.
+</para>
+<mediaobject>
+ <videoobject>
+ <videodata contentdepth="315" contentwidth="560" fileref="https://www.youtube.com/embed/un2KVJY3Yis"/>
+ </videoobject>
+ <caption><para><phrase>Ekos introductory video</phrase></para></caption>
+</mediaobject>
+<para>Features:</para>
+<itemizedlist>
+ <listitem>
+ <para>
+ Control your telescope, CCD (& DSLRs), filter wheel, focuser, guider, adaptive optics unit, and any INDI-compatible auxiliary device from Ekos.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Built-in</emphasis> native Auto Guiding with support for automatic dithering between exposures and support for Adaptive Optics devices in addition to traditional guiders.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://knro.blogspot.com/2013/10/demo-of-ekos-alignment-module.html">Extremely accurate GOTOs</ulink> using astrometry.net solver (both Online and Offline solvers supported).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Load & Slew: Load a FITS image, slew to solved coordinates, and center the mount on the exact image coordinates in order to get the same desired frame.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Measure & Correct Polar Alignment errors using astromety.net solver.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Easy to use <ulink url="https://www.youtube.com/watch?v=sx6Zz9lNd5Q">Polar Alignment Assistant</ulink> tool. A very quick and reliable tool to polar align your German Equatorial Mount!
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Capture and record <ulink url="https://www.youtube.com/watch?v=OJFZWwlAQRM">video streams in SER format</ulink>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Completely <ulink url="https://www.youtube.com/watch?v=85L3J_iiXZ4">automated scheduler</ulink> to control all your observatory equipment, select the best targets for imaging given current conditions and constraints, monitor weather conditions, and capture your data while you are away!
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>Smart</emphasis> Dark Library: All your dark frames with different binning/temperature/frame settings are saved for future use. Ekos re-uses dark frames intelligently without taking unnecessary captures. You can configure how long you want to reuse all the dark frames.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Define multiple driver profiles for local and remote setups. Switch among them easily.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Auto and manual focus modes using Half-Flux-Radius (HFR) method.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="https://www.youtube.com/watch?v=stsrcsPxUZA">Automated <emphasis>unattended</emphasis> meridian flip</ulink>. Ekos performs post meridian flip alignment, calibration, focusing, and guiding to resume the capture session.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Automatic focus between exposures when a user-configurable HFR limit is exceeded.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Powerful sequence queue for batch capture of images with optional prefixes, timestamps, filter wheel selection, and much more!
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Export and import sequence queue sets as Ekos Sequence Queue (.esq) files.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://youtu.be/fg2HDFg_dCE">Center the telescope anywhere in a captured FITS image</ulink> or any FITS with World Coordinate System (WCS) header.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Automatic flat field capture, just set the desired ADU and let Ekos does the rest!
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Automatic abort and resumption of exposure tasks if guiding errors exceed a user-configurable value.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Support for dome slaving.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Complete integration with &kstars; Observation Planner and SkyMap.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fully scriptable via <ulink url="http://www.freedesktop.org/wiki/Software/dbus/">DBus</ulink>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Integrate with all INDI native devices.
+ </para>
+ </listitem>
+</itemizedlist>
+
+&tool-ekos-setup;
+&tool-ekos-user-interface;
+&tool-ekos-profile-wizard;
+&tool-ekos-profile-editor;
+&tool-ekos-logs;
+&tool-ekos-capture;
+&tool-ekos-focus;
+&tool-ekos-guide;
+&tool-ekos-align;
+&tool-ekos-scheduler;
+&tool-ekos-fits-viewer;
+&tool-ekos-tutorials;
+
+</sect1>
diff --git a/doc/ekos_astrometry.png b/doc/ekos_astrometry.png
new file mode 100644
index 000000000..c690b58e7
Binary files /dev/null and b/doc/ekos_astrometry.png differ
diff --git a/doc/ekos_capture.png b/doc/ekos_capture.png
new file mode 100644
index 000000000..24f242abf
Binary files /dev/null and b/doc/ekos_capture.png differ
diff --git a/doc/ekos_focus.png b/doc/ekos_focus.png
new file mode 100644
index 000000000..3b2ee5e3e
Binary files /dev/null and b/doc/ekos_focus.png differ
diff --git a/doc/ekos_guide.png b/doc/ekos_guide.png
new file mode 100644
index 000000000..ff10b363d
Binary files /dev/null and b/doc/ekos_guide.png differ
diff --git a/doc/ekos_guide_phd2.png b/doc/ekos_guide_phd2.png
new file mode 100644
index 000000000..35d84e714
Binary files /dev/null and b/doc/ekos_guide_phd2.png differ
diff --git a/doc/ekos_profile_guider_select.png b/doc/ekos_profile_guider_select.png
new file mode 100644
index 000000000..f44cfb58d
Binary files /dev/null and b/doc/ekos_profile_guider_select.png differ
diff --git a/doc/ekos_remote_astrometry.png b/doc/ekos_remote_astrometry.png
new file mode 100644
index 000000000..4321f0c9e
Binary files /dev/null and b/doc/ekos_remote_astrometry.png differ
diff --git a/doc/ekos_rotator_settings.png b/doc/ekos_rotator_settings.png
new file mode 100644
index 000000000..85df9bb9f
Binary files /dev/null and b/doc/ekos_rotator_settings.png differ
diff --git a/doc/ekos_scheduler.png b/doc/ekos_scheduler.png
new file mode 100644
index 000000000..7549a4114
Binary files /dev/null and b/doc/ekos_scheduler.png differ
diff --git a/doc/ekos_summary.png b/doc/ekos_summary.png
new file mode 100644
index 000000000..87943542c
Binary files /dev/null and b/doc/ekos_summary.png differ
diff --git a/doc/ekos_summary_cheatsheet.png b/doc/ekos_summary_cheatsheet.png
new file mode 100644
index 000000000..d205582bf
Binary files /dev/null and b/doc/ekos_summary_cheatsheet.png differ
diff --git a/doc/file_settings.png b/doc/file_settings.png
new file mode 100644
index 000000000..1e3a227c0
Binary files /dev/null and b/doc/file_settings.png differ
diff --git a/doc/filter_settings.png b/doc/filter_settings.png
new file mode 100644
index 000000000..9972fbef4
Binary files /dev/null and b/doc/filter_settings.png differ
diff --git a/doc/fits_settings.png b/doc/fits_settings.png
new file mode 100644
index 000000000..88f19e900
Binary files /dev/null and b/doc/fits_settings.png differ
diff --git a/doc/fitsviewer_embedded.png b/doc/fitsviewer_embedded.png
new file mode 100644
index 000000000..e95a1bc7e
Binary files /dev/null and b/doc/fitsviewer_embedded.png differ
diff --git a/doc/fitsviewer_histogram.png b/doc/fitsviewer_histogram.png
new file mode 100644
index 000000000..cdb2528aa
Binary files /dev/null and b/doc/fitsviewer_histogram.png differ
diff --git a/doc/focus_ccdfw_group.png b/doc/focus_ccdfw_group.png
new file mode 100644
index 000000000..b043e8ecb
Binary files /dev/null and b/doc/focus_ccdfw_group.png differ
diff --git a/doc/focus_relative_profile.png b/doc/focus_relative_profile.png
new file mode 100644
index 000000000..0f499462d
Binary files /dev/null and b/doc/focus_relative_profile.png differ
diff --git a/doc/focus_settings.png b/doc/focus_settings.png
new file mode 100644
index 000000000..14a1e4190
Binary files /dev/null and b/doc/focus_settings.png differ
diff --git a/doc/focus_vcurve.png b/doc/focus_vcurve.png
new file mode 100644
index 000000000..14e3c0b1d
Binary files /dev/null and b/doc/focus_vcurve.png differ
diff --git a/doc/focuser_group.png b/doc/focuser_group.png
new file mode 100644
index 000000000..64443810c
Binary files /dev/null and b/doc/focuser_group.png differ
diff --git a/doc/guide_calibration_settings.png b/doc/guide_calibration_settings.png
new file mode 100644
index 000000000..70a1f890d
Binary files /dev/null and b/doc/guide_calibration_settings.png differ
diff --git a/doc/guide_drift_graphics.png b/doc/guide_drift_graphics.png
new file mode 100644
index 000000000..32f31841f
Binary files /dev/null and b/doc/guide_drift_graphics.png differ
diff --git a/doc/guide_guide_settings.png b/doc/guide_guide_settings.png
new file mode 100644
index 000000000..ed357a765
Binary files /dev/null and b/doc/guide_guide_settings.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 9ffee73e0..decbd11cb 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -4,14 +4,14 @@
<!ENTITY blackbody SYSTEM "blackbody.docbook">
<!ENTITY calc-angdist SYSTEM "calc-angdist.docbook">
<!ENTITY calc-apcoords SYSTEM "calc-apcoords.docbook">
+ <!ENTITY calc-dayduration SYSTEM "calc-dayduration.docbook">
<!ENTITY calc-ecliptic SYSTEM "calc-ecliptic.docbook">
<!ENTITY calc-eqgal SYSTEM "calc-eqgal.docbook">
<!ENTITY calc-equinox SYSTEM "calc-equinox.docbook">
- <!ENTITY calc-horiz SYSTEM "calc-horizontal.docbook">
- <!ENTITY calc-planetcoords SYSTEM "calc-planetcoords.docbook">
<!ENTITY calc-geodetic SYSTEM "calc-geodetic.docbook">
- <!ENTITY calc-dayduration SYSTEM "calc-dayduration.docbook">
+ <!ENTITY calc-horiz SYSTEM "calc-horizontal.docbook">
<!ENTITY calc-julian SYSTEM "calc-julianday.docbook">
+ <!ENTITY calc-planetcoords SYSTEM "calc-planetcoords.docbook">
<!ENTITY calc-sidereal SYSTEM "calc-sidereal.docbook">
<!ENTITY calculator SYSTEM "calculator.docbook">
<!ENTITY cequator SYSTEM "cequator.docbook">
@@ -33,6 +33,7 @@
<!ENTITY flux SYSTEM "flux.docbook">
<!ENTITY geocoords SYSTEM "geocoords.docbook">
<!ENTITY greatcircle SYSTEM "greatcircle.docbook">
+ <!ENTITY hips SYSTEM "hips.docbook">
<!ENTITY horizon SYSTEM "horizon.docbook">
<!ENTITY hourangle SYSTEM "hourangle.docbook">
<!ENTITY indi SYSTEM "indi.docbook">
@@ -53,19 +54,31 @@
<!ENTITY telescopes SYSTEM "telescopes.docbook">
<!ENTITY timezones SYSTEM "timezones.docbook">
<!ENTITY tool-altvstime SYSTEM "altvstime.docbook">
- <!ENTITY tool-eyepieceview SYSTEM "eyepieceview.docbook">
<!ENTITY tool-calculator SYSTEM "calculator.docbook">
<!ENTITY tool-details SYSTEM "details.docbook">
- <!ENTITY tool-whatsup SYSTEM "wut.docbook">
- <!ENTITY tool-scriptbuilder SYSTEM "scriptbuilder.docbook">
- <!ENTITY tool-solarsys SYSTEM "solarsys.docbook">
+ <!ENTITY tool-ekos SYSTEM "ekos.docbook">
+ <!ENTITY tool-ekos-align SYSTEM "ekos-align.docbook">
+ <!ENTITY tool-ekos-capture SYSTEM "ekos-capture.docbook">
+ <!ENTITY tool-ekos-fits-viewer SYSTEM "ekos-fits-viewer.docbook">
+ <!ENTITY tool-ekos-focus SYSTEM "ekos-focus.docbook">
+ <!ENTITY tool-ekos-guide SYSTEM "ekos-guide.docbook">
+ <!ENTITY tool-ekos-logs SYSTEM "ekos-logs.docbook">
+ <!ENTITY tool-ekos-profile-editor SYSTEM "ekos-profile-editor.docbook">
+ <!ENTITY tool-ekos-profile-wizard SYSTEM "ekos-profile-wizard.docbook">
+ <!ENTITY tool-ekos-scheduler SYSTEM "ekos-scheduler.docbook">
+ <!ENTITY tool-ekos-setup SYSTEM "ekos-setup.docbook">
+ <!ENTITY tool-ekos-tutorials SYSTEM "ekos-tutorials.docbook">
+ <!ENTITY tool-ekos-user-interface SYSTEM "ekos-user-interface.docbook">
+ <!ENTITY tool-eyepieceview SYSTEM "eyepieceview.docbook">
+ <!ENTITY tool-fitsviewer SYSTEM "fitsviewer.docbook">
<!ENTITY tool-jmoons SYSTEM "jmoons.docbook">
<!ENTITY tool-obsplanner SYSTEM "obsplanner.docbook">
- <!ENTITY tool-fitsviewer SYSTEM "fitsviewer.docbook">
+ <!ENTITY tool-scriptbuilder SYSTEM "scriptbuilder.docbook">
+ <!ENTITY tool-solarsys SYSTEM "solarsys.docbook">
+ <!ENTITY tool-whatsup SYSTEM "wut.docbook">
<!ENTITY tools SYSTEM "tools.docbook">
<!ENTITY utime SYSTEM "utime.docbook">
<!ENTITY zenith SYSTEM "zenith.docbook">
- <!ENTITY hips SYSTEM "hips.docbook">
<!ENTITY % addindex "INCLUDE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
]>
diff --git a/doc/kstars_annotation.png b/doc/kstars_annotation.png
new file mode 100644
index 000000000..e366d46f0
Binary files /dev/null and b/doc/kstars_annotation.png differ
diff --git a/doc/kstars_m44_mac.png b/doc/kstars_m44_mac.png
new file mode 100644
index 000000000..cd5701196
Binary files /dev/null and b/doc/kstars_m44_mac.png differ
diff --git a/doc/limit_settings.png b/doc/limit_settings.png
new file mode 100644
index 000000000..143bebe49
Binary files /dev/null and b/doc/limit_settings.png differ
diff --git a/doc/list-add.png b/doc/list-add.png
new file mode 100644
index 000000000..5ebf6f87b
Binary files /dev/null and b/doc/list-add.png differ
diff --git a/doc/media-playback-pause.png b/doc/media-playback-pause.png
new file mode 100644
index 000000000..be1c9478f
Binary files /dev/null and b/doc/media-playback-pause.png differ
diff --git a/doc/media-playback-start.png b/doc/media-playback-start.png
new file mode 100644
index 000000000..88ee27419
Binary files /dev/null and b/doc/media-playback-start.png differ
diff --git a/doc/mosaic_wizard.png b/doc/mosaic_wizard.png
new file mode 100644
index 000000000..423d0c52c
Binary files /dev/null and b/doc/mosaic_wizard.png differ
diff --git a/doc/polar_alignment_result.png b/doc/polar_alignment_result.png
new file mode 100644
index 000000000..4fe911090
Binary files /dev/null and b/doc/polar_alignment_result.png differ
diff --git a/doc/polar_assistant_main.png b/doc/polar_assistant_main.png
new file mode 100644
index 000000000..74e49f25c
Binary files /dev/null and b/doc/polar_assistant_main.png differ
diff --git a/doc/profile_editor.png b/doc/profile_editor.png
new file mode 100644
index 000000000..3b17f25a9
Binary files /dev/null and b/doc/profile_editor.png differ
diff --git a/doc/profile_wizard_done.png b/doc/profile_wizard_done.png
new file mode 100644
index 000000000..be46721ce
Binary files /dev/null and b/doc/profile_wizard_done.png differ
diff --git a/doc/profile_wizard_remote.png b/doc/profile_wizard_remote.png
new file mode 100644
index 000000000..82b3409ea
Binary files /dev/null and b/doc/profile_wizard_remote.png differ
diff --git a/doc/profile_wizard_select.png b/doc/profile_wizard_select.png
new file mode 100644
index 000000000..1919c4c53
Binary files /dev/null and b/doc/profile_wizard_select.png differ
diff --git a/doc/profile_wizard_welcome.png b/doc/profile_wizard_welcome.png
new file mode 100644
index 000000000..3d69bc386
Binary files /dev/null and b/doc/profile_wizard_welcome.png differ
diff --git a/doc/scheduler_planner.png b/doc/scheduler_planner.png
new file mode 100644
index 000000000..1b428e5a4
Binary files /dev/null and b/doc/scheduler_planner.png differ
diff --git a/doc/security-high.png b/doc/security-high.png
new file mode 100644
index 000000000..71a43b18c
Binary files /dev/null and b/doc/security-high.png differ
diff --git a/doc/security-low.png b/doc/security-low.png
new file mode 100644
index 000000000..12afdbe35
Binary files /dev/null and b/doc/security-low.png differ
diff --git a/doc/security-medium.png b/doc/security-medium.png
new file mode 100644
index 000000000..20626538e
Binary files /dev/null and b/doc/security-medium.png differ
diff --git a/doc/sequence_settings.png b/doc/sequence_settings.png
new file mode 100644
index 000000000..efb7c983b
Binary files /dev/null and b/doc/sequence_settings.png differ
diff --git a/doc/solver_settings.png b/doc/solver_settings.png
new file mode 100644
index 000000000..cdc63477a
Binary files /dev/null and b/doc/solver_settings.png differ
diff --git a/doc/star_profile_examine_pixels.png b/doc/star_profile_examine_pixels.png
new file mode 100644
index 000000000..3c3fcadb3
Binary files /dev/null and b/doc/star_profile_examine_pixels.png differ
diff --git a/doc/star_profile_final.png b/doc/star_profile_final.png
new file mode 100644
index 000000000..21d208209
Binary files /dev/null and b/doc/star_profile_final.png differ
diff --git a/doc/star_profile_main.png b/doc/star_profile_main.png
new file mode 100644
index 000000000..5857425e9
Binary files /dev/null and b/doc/star_profile_main.png differ
diff --git a/doc/star_profile_toolbar1.png b/doc/star_profile_toolbar1.png
new file mode 100644
index 000000000..f4fce9f6c
Binary files /dev/null and b/doc/star_profile_toolbar1.png differ
diff --git a/doc/star_profile_toolbar2.png b/doc/star_profile_toolbar2.png
new file mode 100644
index 000000000..d2ca7c495
Binary files /dev/null and b/doc/star_profile_toolbar2.png differ
diff --git a/doc/star_profile_vertical.png b/doc/star_profile_vertical.png
new file mode 100644
index 000000000..5d08a5a3d
Binary files /dev/null and b/doc/star_profile_vertical.png differ
diff --git a/doc/tools.docbook b/doc/tools.docbook
index 26a0c947d..81deadc08 100644
--- a/doc/tools.docbook
+++ b/doc/tools.docbook
@@ -14,6 +14,7 @@ some more advanced aspects of astronomy and the night sky.
<listitem><para><link linkend="tool-eyepieceview">Simulate Eyepiece View</link></para></listitem>
<listitem><para><link linkend="tool-scriptbuilder">Script Builder</link></para></listitem>
<listitem><para><link linkend="tool-solarsys">Solar System Viewer</link></para></listitem>
+<listitem><para><link linkend="tool-ekos">Ekos</link></para></listitem>
<listitem><para><link linkend="tool-jmoons">Jupiter Moons Tool</link></para></listitem>
<listitem><para><link linkend="tool-obsplanner">Observation Planner</link></para></listitem>
<listitem><para><link linkend="tool-fitsviewer">FITS Viewer</link></para></listitem>
@@ -26,6 +27,7 @@ some more advanced aspects of astronomy and the night sky.
&tool-whatsup;
&tool-scriptbuilder;
&tool-solarsys;
+&tool-ekos;
&tool-jmoons;
&tool-obsplanner;
&tool-fitsviewer;
diff --git a/doc/view-filter.png b/doc/view-filter.png
new file mode 100644
index 000000000..911c4cb54
Binary files /dev/null and b/doc/view-filter.png differ
diff --git a/doc/view-fullscreen.png b/doc/view-fullscreen.png
new file mode 100644
index 000000000..dbaf1c1ef
Binary files /dev/null and b/doc/view-fullscreen.png differ
diff --git a/doc/view-refresh.png b/doc/view-refresh.png
new file mode 100644
index 000000000..3692c7bd4
Binary files /dev/null and b/doc/view-refresh.png differ
More information about the kde-doc-english
mailing list