ekos summary

Ekos is include with KStars. KStars/Ekos is already included with your StellarMate gadget. It is also available for Linux, MacOS, and Windows 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 VNC), Ekos can be accessed from the Tools menu or via the Ekos icon on the main tool bar, or by a keyboard shortcut (Ctrl + K). In addition to the Ekos window, KStars provides a more detailed INDI Control Panel where you can directly set and control the device parameters.

When running Ekos, it is not necessary to start INDI Server via StellarMate Web Manager as Ekos manages that transparently.

kstars annotation

User Interface

Ekos Astrophotography Tool is organized into several Modules. A module is set of functions and tasks for a particular step in astrophotography and/or data acquisition. Currently, the following modules are included with Ekos:

  • Setup & Summary Module
  • Scheduler Module
  • Capture Module
  • Focus Module
  • Alignment Module
  • Guide Module
  • Mount Module
  • Observatory Module


Each module has its own tab and icon in the graphical user interface as illustrated in the screenshot below:



Summary & Setup Module

As its name suggest, this is where you will create and manage your equipment profile, and connect to your devices. It allows the user to access INDI control panel, which allows the user to control every detail of their equipment. Users can also enable logging and start logging the whole Ekos process or specify the equipment they want to monitor and log. It also provides a summary view where the capture progress along with the focus & guide operations are displayed in a compact format to convey the most important information relevant to the user.

Scheduler Module

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 target, specifiy 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.

Capture Module

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.

Focus Module

Measure the sharpness of your images in the focus module by calculating Half-Flux-Radius. The lower the HFR, the more sharp 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.

Mount Module

Mount control can be either done via the Sky Map interactivly 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.

Observatory Module

Dome parking state and position can be controlled in this module. Shutter can be closed or opened. A weather panel is also available for users to check the weather if they have a weather station.

Alignment Module

Aligning your equipment correctly is important to get the correct image from your telescope. The Alignment module has Solver that automatically aligns your equipment using a Capture & Solve process. The module can align your equipment using solvers like ASTAP and Astro.net. It can do the alignment process using the solvers if you are either online or offline. Polar alignment is also available in order to align a German equatorial mount.

Guide Module

To achieve long exposure astrophotography, guiding is necessary to ensure the image is locked and stablized 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.

Profile Wizard

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 instrustions to setup your first equipment profile.

Greeting Page

profile wizard welcome

The first greeting screen contain some links to learn more about Ekos & INDI. Click Next to continue.

Equipment Location Page

Next you will be presented with the equipment location page. Your selection depends on where your equipmment is connected to:

  • Equipment is attached to your PC: Select this option if Ekos is running on your StellarMate (via HDMI or VNC), or PC (Windows/Linux) or MacOS.
  • Equipment is attached to StellarMate or a remote computer: Select this option if Ekos is running on your PC (Windows/Linux) or MacOS, and your equipment is connected to StellarMate or a remote computer.

profile wizard select

Click next to continue.

Remote Device Type Page

In case selected the 2nd option in the last step, you shall be presented with the Remote Device Type Page, here you will choose what type of device you are using. It could be StellarMate, AtikBase or any other remote devices such as another Computer for example.

profile wizard device

Remote Connection Page

In case selected StellarMate in the last step, you shall be presented with the Remote Connect Page for StellarMate, 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 stellarmate.  The hostname should be stellarmate.local. That is, if you remove the underscore, and append .local, then you will get the unit hostname. You can always use the StellarMate App to change the unit default hostname to a name of your choice.

profile wizard remote

Profile Creation Page

Now you get to name your equipment profile. Afterwards, select which guider application to use. The Internal Guider is the only officially supported selection in StellarMate. You may opt to select PHD2/LinGuider but the details are out of the scope of this documentation. If additional services are desired, check the ones you want to run.

profile wizard done

In the example above, we select Remote Astrometry, WatchDog, and SkySafari drivers. The detailed explanations for each in provided in the tooltip when you over them. Once done, click Create Profile button. You should now be presented with the Profile Editor.

Profile Editor

profile editor


 You can define profiles for your equipment and their connection mode using the Profile Editor. Ekos comes pre-installed with the Simulators profile which can be used to start simulator devices for demonstration purposes:

  • Connection Mode: Ekos can be started either locally or remotely. Local mode is when Ekos is running in the same machine as INDI server, i.e. all the devices are connected directly to the machine. If you run INDI server on a remote machine (for example, on StellarMate or on a Raspberry PI), you need to set the INDI server host and port.
  • Auto Connect: 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 (e.g. change baud rate or IP address or any other settings) before you connect to it.
  • Site Info: Optionally, you can check the Site Info checkbox and Ekos will load the current city and timezone whenever is Ekos is started with this profile. This can be useful when connecting to remote geographic site so that Ekos is in sync location and time wise.
  • Guiding: 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.
  • INDI Web Manager: 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.
  • INDI Hub: Share your observatory on indihub.space in one of these modes: Solo, Share, or Robotic (Experimental).
  • Device Selection: Select your devices from each category. Please note that if you have a CCD with a guide head, you can leave the guider dropdown menu blank as Ekos will auto-detect the guide head from the CCD camera. Similarly, if your CCD includes embedded filter wheel support, then you do not need to specify the filter wheel device in the filter dropdown menu.
  • Telescope Selection: Select your primary and secondary telescopes. You can enter your telescope's information as well as your eyepiece, lens and filter. This is important to ensure that the image being captured is not blurry.
  • Scripts: Adjust pre-driver and post-driver delays and scripts for each driver. A rule can be defined for each driver in case there is a need to introduce delays before and/or after starting a particular driver. The fields before the driver selection dropdown are to be executed before the driver is started, whereas the fields after the driver selection dropdown are to be executed after the driver started. The script field, if specified, should include the full path to an executable script with the appropiate permissions. All drivers configured in the scripts edit or would be started first and in order before the rest of the equipment profile drivers.

profile editor scripts

Start & Stop INDI

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.

Connect & Disconnect Devices

Connect to INDI server. Based on the devices connected, Ekos modules (CCD, Focus, Guide...etc) will be established and available to use.

Once you are ready, click Start INDI to establish INDI server and connection to your equipment. Ekos shall create the various module icons (Mount, Capture, Focus..etc) as connection is established with the device.

Optical Trains

optical trains

Optical Trains organize your equipment into separate unique optical paths. Each camera must have its own optical train. The following elements are specified in each train:

  1. Mount: Select which mount to use. Typically, all optical trains in the same profile use the same mount.
  2. Dust Cap: Select a mechanized dust cap if any (e.g. FlipFlat).
  3. LightBox: Select a flat field lightbox if any (e.g. FlipFlat).
  4. Scope or DSLR Lens: Select the scope or lens used in the optical path. To add, edit, or delete optical elements, tap the Telescope & Lens button.
  5. Reducer / Barlow: Select if any reducer or barlow is used in the train.
    • Reducer: By default it is specified at 1.0 which means that has no effect. Range is 0.1x to 0.9x.
    • Barlow: If the value specified is over 1.0x, then it is considered a barlow element (focal length is increased by this factor).
  6. Rotator: Select a mechanized rotator if any.
  7. Focuser: Select a mechanized focuser if any.
  8. Filter Wheel: Select a filter wheel. This must be a standalone filter wheel connected to StellarMate via USB. If you have a filter wheel that is embedded in a camera, leave this field empty.
  9. Camera: Select imaging camera for this train. Each camera must have its own train.
  10. Guider: Select the device that receives the guiding correction pulses. This can be one of the following devices:
    • Mount: If the Mount can receive guiding correction pulses, then it is best to select it so that the pulses are directly sent to the mount. This is the recommended option.
    • ST4: If using an ST4 cable between the guide camera and mount, then you should select the Guide Camera as the Guider.
    • Dedicated Guider: If using a dedicated guider interface device (like Shoestring GPUSB) then select it as the Guider.

If a device provides more than one functionality, then it should be specified in all relative fields. For example, MoonLite Nightcrawler is a Rotator and Focuser at the same time, so we select NightCrawler under both Rotator and Focuser fields.

Once the optical trains are configured, specify which trains to use in each Ekos module. Typically, the Primary optical train is used in Capture, Focus, and Align modules while the Secondary train is used in Guide.

You can also Add / Update Telescope & lens then use them in different trains.

                                                                            telescope editor      

dslr editor


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 algother. So only enable the necessary logs necessary. 

The following short video explains how to use the Logging feature to submit logs.