Changeset View
Changeset View
Standalone View
Standalone View
doc/ekos-profile-editor.docbook
- This file was added.
| 1 | <sect2 id="ekos-profile-editor"> | ||||
|---|---|---|---|---|---|
| 2 | <title>Profile Editor</title> | ||||
| 3 | <indexterm> | ||||
| 4 | <primary>Tools</primary> | ||||
| 5 | <secondary>Ekos</secondary> | ||||
| 6 | <tertiary>Profile Editor</tertiary> | ||||
| 7 | </indexterm> | ||||
| 8 | <screenshot> | ||||
| 9 | <screeninfo> | ||||
| 10 | Profile Editor | ||||
| 11 | </screeninfo> | ||||
| 12 | <mediaobject> | ||||
| 13 | <imageobject> | ||||
| 14 | <imagedata fileref="profile_editor.png" format="PNG"/> | ||||
| 15 | </imageobject> | ||||
| 16 | <textobject> | ||||
| 17 | <phrase>Profile Editor</phrase> | ||||
| 18 | </textobject> | ||||
| 19 | </mediaobject> | ||||
| 20 | </screenshot> | ||||
| 21 | <variablelist> | ||||
| 22 | <varlistentry> | ||||
| 23 | <term>Profiles</term> | ||||
| 24 | <listitem> | ||||
| 25 | <para> | ||||
| 26 | 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: | ||||
| 27 | </para> | ||||
| 28 | <itemizedlist> | ||||
| 29 | <listitem> | ||||
| 30 | <para> | ||||
| 31 | <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. | ||||
| 32 | </para> | ||||
| 33 | </listitem> | ||||
| 34 | <listitem> | ||||
| 35 | <para> | ||||
| 36 | <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. | ||||
| 37 | </para> | ||||
| 38 | </listitem> | ||||
| 39 | <listitem> | ||||
| 40 | <para> | ||||
| 41 | <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. | ||||
| 42 | </para> | ||||
| 43 | </listitem> | ||||
| 44 | <listitem> | ||||
| 45 | <para> | ||||
| 46 | <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. | ||||
| 47 | </para> | ||||
| 48 | </listitem> | ||||
| 49 | <listitem> | ||||
| 50 | <para> | ||||
| 51 | <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. | ||||
| 52 | </para> | ||||
| 53 | </listitem> | ||||
| 54 | <listitem> | ||||
| 55 | <para> | ||||
| 56 | <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. | ||||
| 57 | </para> | ||||
| 58 | </listitem> | ||||
| 59 | </itemizedlist> | ||||
| 60 | </listitem> | ||||
| 61 | </varlistentry> | ||||
| 62 | <varlistentry> | ||||
| 63 | <term>Start & Stop INDI</term> | ||||
| 64 | <listitem> | ||||
| 65 | <para> | ||||
| 66 | 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; | ||||
| 67 | </para> | ||||
| 68 | </listitem> | ||||
| 69 | </varlistentry> | ||||
| 70 | <varlistentry> | ||||
| 71 | <term>Connect & Disconnect Devices</term> | ||||
| 72 | <listitem> | ||||
| 73 | <para> | ||||
| 74 | Connect to INDI server. Based on the devices connected, Ekos modules (CCD, Focus, Guide...etc) will be established and available to use. | ||||
| 75 | </para> | ||||
| 76 | <para> | ||||
| 77 | 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. | ||||
| 78 | </para> | ||||
| 79 | </listitem> | ||||
| 80 | </varlistentry> | ||||
| 81 | </variablelist> | ||||
| 82 | </sect2> | ||||