Instrument Neutral Distributed Interface (INDI) Page 1/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
Kstars Indi OnStep Telescope Driver
Version Author Date 1.4 A. Zwingelstein 29/01/2018 Instrument Neutral Distributed Interface (INDI) Page 2/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
Index 1 1 Presentation...... 4 1.1 What is OnStep...... 4 1.2 This driver...... 4 1.3 references...... 4 2 2 Status...... 5 3 3 Screenshots...... 7 3.1 Kstars main window...... 8 3.1.1 Kstars overview...... 9 3.2 Main Control...... 10 3.2.1 Main Control usage ...... 11 3.2.1.a 3.2.1.a Connection :tested...... 11 3.2.1.b 3.2.1.b Eq. Coordinates :tested...... 11 3.2.1.c 3.2.1.c Abort Motion :tested...... 11 3.2.1.d 3.2.1.d Track Mode :tested...... 11 3.2.1.e 3.2.1.e Tracking :tested...... 11 3.2.1.f 3.2.1.f Track Rates : Untested...... 12 3.2.1.g 3.2.1.g Pier Side : Untested...... 12 3.2.1.h 3.2.1.h Use Pulse Cmd : Untested...... 12 3.2.1.i 3.2.1.i Reticule ±:tested...... 12 3.2.1.j 3.2.1.j Align using n stars : Untested...... 13 3.2.1.k 3.2.1.k Process Align : Untested...... 13 3.2.1.l 3.2.1.l Slew Elevation Limits :tested...... 14 3.2.1.m 3.2.1.m Object Info : Not Tested...... 14 3.3 Connection...... 15 3.3.1 Connection usage ...... 16 3.3.1.a 3.3.1.a Driver Info:tested...... 16 3.3.1.b 3.3.1.b Connection Mode:tested...... 16 3.3.1.c 3.3.1.c Ports :tested...... 16 3.3.1.d 3.3.1.d Baud Rate :tested...... 16 3.3.1.e 3.3.1.e Auto Search:...... 16 3.3.1.f 3.3.1.f Refresh :tested...... 16 3.3.1.g 3.3.1.g System Ports:tested...... 16 3.4 Options...... 17 3.4.1 Options usage ...... 18 3.4.1.a 3.4.1.a Debug: Tested...... 18 3.4.1.b 3.4.1.b Simulation: Tested...... 18 3.4.1.c 3.4.1.c Configuration: Tested...... 18 3.4.1.d 3.4.1.d Snoop Devices: Tested...... 18 3.4.1.e 3.4.1.e Dome Policy: Not Tested in real operation, I have no dome :-(...... 18 3.4.1.f 3.4.1.f Scope Properties: Tested...... 18 3.4.1.g 3.4.1.g Debug Levels: Tested...... 18 3.4.1.h 3.4.1.h Logging Levels: Tested...... 19 3.4.1.i 3.4.1.i Log Outputs: Tested...... 19 3.4.1.j 3.4.1.j Scope Name: Tested...... 19 3.4.1.k 3.4.1.k Scope Configs:...... 19 3.4.1.l 3.4.1.l Joystick: Tested...... 19 3.5 Motion Control...... 20 3.5.1 Motion Control usage ...... 21 3.5.1.a 3.5.1.a Motion N/S: Tested...... 21 Instrument Neutral Distributed Interface (INDI) Page 3/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.5.1.b 3.5.1.b Motion W/E: Tested...... 21 3.5.1.c 3.5.1.c Slew Target: Tested...... 21 3.5.1.d 3.5.1.d Pec Playback:To be done...... 21 3.5.1.e 3.5.1.e Tracking Frequency: Tested...... 21 3.5.1.f 3.5.1.f Max Slew Rate: Tested...... 21 3.6 Site Management...... 22 3.6.1 Site Management usage ...... 23 3.6.1.a 3.6.1.a UTC Time: Tested...... 23 3.6.1.b 3.6.1.b Scope Location: Tested...... 23 3.6.1.c 3.6.1.c Sites: Tested...... 23 3.6.1.d 3.6.1.d Site Name: Tested...... 23 3.7 Guide...... 24 3.7.1 Guide usage ...... 25 3.7.1.a 3.7.1.a Guide N/S: Tested...... 25 3.7.1.b 3.7.1.b Guide E/W: Tested...... 25 3.8 Focuser...... 26 3.8.1 Focuser usage ...... 27 3.8.1.a 3.8.1.a Motion: Tested...... 27 3.8.1.b 3.8.1.b Focus Timer: Tested...... 27 3.8.1.c 3.8.1.c Mode: Tested...... 27 3.9 Firmware Data...... 28 3.9.1 Firmware data usage ...... 29 3.9.1.a 3.9.1.a Firmware Info: Tested...... 29 3.10 Library...... 30 3.10.1 Library usage ...... 31 3.10.1.a 3.10.1.a Solar System:Untested...... 31 3.10.1.b 3.10.1.b Star Catalogs:Untested...... 31 3.10.1.c 3.10.1.c Deep Sky Catalogs:Untested...... 31 3.10.1.d 3.10.1.d Object Number:Untested...... 31 3.11 OnStep Status...... 32 3.11.1 OnStep Status usage ...... 33 3.11.1.a 3.11.1.a :GU# Return: Tested...... 33 3.11.1.b 3.11.1.b Tracking: Tested...... 33 3.11.1.c 3.11.1.c Refractoring: Tested...... 33 3.11.1.d 3.11.1.d Park: Tested...... 33 3.11.1.e 3.11.1.e Pec: Tested...... 33 3.11.1.f 3.11.1.f TimeSync: Tested...... 33 3.11.1.g 3.11.1.g Mount Type: Tested...... 33 3.11.1.h 3.11.1.h Error: Tested...... 33 Instrument Neutral Distributed Interface (INDI) Page 4/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
1 Presentation
1.1 What is OnStep OnStep is a project started and heavily developed by Howard Dutton The software supports several type of hardware like Arduino, Teensy and many others.
1.2 This driver The subject of this document is the INDI driver for the OnStep Telescope controller. The driver development started based on the INDI lx200_classic telescope driver as a starting point. Since OnStep is really versatile and has many functionalities, the driver is still under development trying to adapt as much as possible to the hardware capabilities. Nevertheless the driver is functional and can be used in production. Thanks to INDI, there are many solid interfaces with other modules that allow the automation starting from a single telescope up to a fully automatized observatory. All the work is focused on the Linux platform.
1.3 references INDI Project : http://www.indilib.org/ http://www.indilib.org/forum.html https://github.com/indilib/indi OnStep Project : https://github.com/hjd1964/OnStep http://stellarjourney.com/ https://groups.io/g/onstep This project https://github.com/azwing/indi https://github.com/azwing/Kicad_OnStep Instrument Neutral Distributed Interface (INDI) Page 5/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
2 Status The driver is still under heavy development but many functionalities are already usable.
Main Functions Status Comments Tested ===: ALIGNMENT hold --> hold ===: COMMUNICATION hold --> hold ===: CONNECTION usable --> Driver Info working y --> Connection Mode working y --> Ports working y --> Auto Search working y --> Refresh working y --> System Ports working y ===: DATETIME hold --> hold ===: FILTER hold --> hold ===: FIRMWARE DATA working --> Firmware Info working y ===: FOCUS Testing --> Motion Testing y --> Focus Timer Testing y --> Mode Testing y ===: GUIDE working --> Guide N/S working y --> Guide E/W working y ===: INFO hold --> hold ===: LIBRARY Testing --> Solar System Testing --> Stars Catalogs Testing --> Deep Sky Catalogs Testing --> Object Number Testing ===: MAINCONTROL working --> Connection working y --> OnSet to do --> Eq Coordinates working y --> Abort Motion working y --> Track Mode working y --> Tracking On/Off working y --> Track Rates Testing --> Parking working y --> Pier Side Testing --> Alignment Testing --> Use Pulse Cmd Testing --> Reticule +/6 working y --> Align n Stars Testing --> Slew Elevation Limit Testing ===: MOTION CONTROL working Instrument Neutral Distributed Interface (INDI) Page 6/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
Main Functions Status Comments Tested --> Motion N/S working y --> Motion W/E working y --> Slew Target working y --> Pec Playback hold --> Tracking Frequency working y --> Max Slew Rate working y ===: ONSTEP STATUS working --> OnStep Status working y ===: OPTIONS working --> Debug working y --> Simulation working y --> Configuration working y --> Snoop devices Testing --> Dome Policy Testing --> Scope Properties working y --> Scope Name working y --> Scope Configs working y --> Joystick working y ===: SITE working --> UTC working y --> Scope Location working y --> Sites working y --> Site Name working y Instrument Neutral Distributed Interface (INDI) Page 7/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3 Screenshots The next pages show screenshots of the actual version. They are all in standard theme except the Kstars view which shows the night vision theme. Instrument Neutral Distributed Interface (INDI) Page 8/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.1 Kstars main window Text Instrument Neutral Distributed Interface (INDI) Page 9/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.1.1 Kstars overview The picture show Kstars window and the device chooser after selection of
3.2 Main Control Instrument Neutral Distributed Interface (INDI) Page 11/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.2.1 Main Control usage
3.2.1.a Connection :tested a set of two radio buttons : - Connect - Disconnect user can connect / disconnect controller communication as per settings in Option Tab OnSet :tested A set of three radio buttons : - Track - Slew - Sync User to select the action to be executed when setting the RA/DEC target values in
3.2.1.b Eq. Coordinates :tested A set of user data entry fields, actual values fields and a set button : - RA : user can enter target values hh:mm:ss in the right text field - DE : user can enter target values hh:mm:ss in the right text field - Set : User can validate the entered values When validating, the driver will execute the action selected under OnSet (Track, Slew or Sync) and the actual value fields will display the actual coordinates
3.2.1.c Abort Motion :tested Any running motion will be unconditionally stopped when clicking the Abort button
3.2.1.d Track Mode :tested A set of four radio buttons where user can choose the tracking rate : - Sidereal - Solar - Lunar - Custom
3.2.1.e Tracking :tested Two radio buttons to Enable / Disable tracking (conditional to Unpark) - On - Off Instrument Neutral Distributed Interface (INDI) Page 12/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.2.1.f Track Rates : Untested A set of user data entry fields, actual values fields and a set button : - RA : user can enter target values Arcs in the right text field - DE : user can enter target values Arcs in the right text field - Set : User can validate the entered values When validating, the driver will set the values in the controller and the actual value fields will display the actual set. Parking : Two radio buttons to Park / Unpark of the telescope - On - Off Setting the parking position still to be done
3.2.1.g Pier Side : Untested Actual Pier side will be displayed Alignment : Untested To be done
3.2.1.h Use Pulse Cmd : Untested Two radio buttons to Enable / Disable pulse guiding - On - Off
3.2.1.i Reticule ±:tested Two radio buttons to Increase / Decrease Reticule brightness - Light, increase brightness - Dark, decrease brightness each click on a button will increase / decrease Reticule brightness Instrument Neutral Distributed Interface (INDI) Page 13/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.2.1.j Align using n stars : Untested Three radio buttons to select star alignment method - 1 star - 2 Stars - 3 Stars At least one of the buttons must be activated for the telescope to start tracking.
1 Star button
Telescope initial position to Northpole And starts tracking
User to select a bright star within kstars
User to slew to The selected star
User to center manually The star
User to sync telescope
Telescope is synced and Resume trackin With consideration of user corrections
End Align
3.2.1.k Process Align : Untested Shows the actual alignment process step Instrument Neutral Distributed Interface (INDI) Page 14/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.2.1.l Slew Elevation Limits :tested A set of user data entry fields, actual values fields and a set button : - Elev Min : user can enter target values -30 to +30 in the right text field - Elev Max : user can enter target values 60 to 90 in the right text field - Set : User can validate the entered values When validating, the driver will store the entered values (if valid) and the actual values are displayed in the actual value fields
3.2.1.m Object Info : Not Tested Instrument Neutral Distributed Interface (INDI) Page 15/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.3 Connection Instrument Neutral Distributed Interface (INDI) Page 16/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.3.1 Connection usage
3.3.1.a Driver Info:tested Under this group the driver displays : - Name : the parent driver on which OnStep is based on - Exec : the actual executable running OnStep driver - Version : the actual OnStep Driver Version - Interface : The INDI interface version
3.3.1.b Connection Mode:tested Two Radio buttons to select connection interface Serial or Ethernet (Ethernet could be Wireless)
3.3.1.c Ports :tested There are three objects : - left side the actual active port - middle, a text field where user can enter a port - right, the button to validate the above user port
3.3.1.d Baud Rate :tested A drop down selection box where user can select the serial port speed, default is 9600
3.3.1.e Auto Search: Two radio buttons where user ca select to activate port auto search
3.3.1.f Refresh :tested A button to re-scan the system about candidate ports
3.3.1.g System Ports:tested a text filed showing the last detected port Instrument Neutral Distributed Interface (INDI) Page 17/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.4 Options Instrument Neutral Distributed Interface (INDI) Page 18/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.4.1 Options usage
3.4.1.a Debug: Tested a set of two radio buttons : - Enable: Enables debugging - Disable: Disables debugging When debugging is enabled additional messages depending on debug level settings are displayed / logged
3.4.1.b Simulation: Tested a set of two radio buttons : - Enable: Enables simulation - Disable: Disables simulation In simulation mode the driver does not connect to the controller but to the virtual telescope simulator. Useful for driver debugging.
3.4.1.c Configuration: Tested a set of three radio buttons : - Load : Loads the configuration files and applies the settings - Save : Saves the actual settings in the configuration file - Default : set the settings to the driver’s defaults
3.4.1.d Snoop Devices: Tested This is a dynamic number of properties that are / or not available from other devices accessible to Indi. Example GPS, Dome ... :
3.4.1.e Dome Policy: Not Tested in real operation, I have no dome :-( :
3.4.1.f Scope Properties: Tested User can set via text entry fields and set button the telescope and guider properties : -Aperture : Telescope aperture in mm -Focal Length : Telescope Focal Length in mm Guider Aperture- : Guider aperture in mm Guider Focal Length- : Guider Focal Length in mm
3.4.1.g Debug Levels: Tested A set of check fields to define the debugging level : - Errors : - Warnings : - Messages : Driver Debug : Instrument Neutral Distributed Interface (INDI) Page 19/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
Scope Verbose :
3.4.1.h Logging Levels: Tested A set of check fields to define the logging level : - Errors : - Warnings : - Messages : Driver Debug : Scope Verbose :
3.4.1.i Log Outputs: Tested A set of check fields to define the logging output: - To Client : - To Log File :
3.4.1.j Scope Name: Tested A text entry field for the Telescope Config File : - Config Name
3.4.1.k Scope Configs: A selection box for the config file to use :
3.4.1.l Joystick: Tested a set of two radio buttons : - Enable: Enables joystick for telescope control - Disable: Disables joystick Instrument Neutral Distributed Interface (INDI) Page 20/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.5 Motion Control Instrument Neutral Distributed Interface (INDI) Page 21/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.5.1 Motion Control usage
3.5.1.a Motion N/S: Tested a set of two radio switches: - Norths : Telescope moves north - South : Telescope moves south buttons are on/off type so first click is on second is off
3.5.1.b Motion W/E: Tested a set of two radio switches: - West: Telescope moves west - East : Telescope moves east buttons are on/off type so first click is on second is off
3.5.1.c Slew Target: Tested Display only : - RA : Displays actual RA target - DE : Displays actual DE Target
3.5.1.d Pec Playback:To be done :
3.5.1.e Tracking Frequency: Tested A text, slider or up/down method data entry and a set button : - Rate : user can enter either via keyboard or mouse the tracking frequency 56,4 to 60,1 in 0,1Hz steps - Set the value is written to the controller (if valid)
3.5.1.f Max Slew Rate: Tested A text, slider or up/down method data entry and a set button : - Rate: user can enter either via keyboard or mouse the tracking rate 1 to 9 in 1 step - Set the value is written to the controller (if valid) Instrument Neutral Distributed Interface (INDI) Page 22/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.6 Site Management Instrument Neutral Distributed Interface (INDI) Page 23/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.6.1 Site Management usage
3.6.1.a UTC Time: Tested Would be nice to have time set on connection a set of data entry fields and a set button : - UTC Time : User entry via system clock - UTC Offset : User entry via system clock - Set : when clicked the system clock is popped up and user can select time from there
3.6.1.b Scope Location: Tested a set of data entry fields and a set button : - Lat (dd:mm:ss) : Site Latitude ± 0 .. 90:00:00 - Lon (dd:mm:ss) :Site Longitude (for the time being positive ...) - Elevation (m): Site Elevation (Altitude) in meter - Set : when clicked data are written to the controller and actual values updated accordingly
3.6.1.c Sites: Tested A set of radio buttons : - Site 1 : - Site 2 : - Site 3 : - Site 4 : When selecting a Site the values are read from the controller and updated in the actual value fields
3.6.1.d Site Name: Tested A text entry field and a set button : - Name : user can enter a Site name - Set : When clicked the site name is written to the controller and actual vale field updated Instrument Neutral Distributed Interface (INDI) Page 24/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.7 Guide Instrument Neutral Distributed Interface (INDI) Page 25/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.7.1 Guide usage
3.7.1.a Guide N/S: Tested a set of two user data entries and a Set button : - North (ms) : guiding pulse time - South (ms) : guiding pulse time - Set : when clicked the guiding pulse is sent for the preset time and actual fields show countdown
3.7.1.b Guide E/W: Tested a set of two user data entries and a Set button : - West (ms) : guiding pulse time - East (ms) : guiding pulse time - Set : when clicked the guiding pulse is sent for the preset time and actual fields show countdown Instrument Neutral Distributed Interface (INDI) Page 26/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.8 Focuser Instrument Neutral Distributed Interface (INDI) Page 27/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.8.1 Focuser usage Focuser support only for DC motor focuser, OnStep supports Two Focusers, to be implemented
3.8.1.a Motion: Tested a set of two radio buttons : - Focus in : moves in focus for time « Focus Timer » - Focus Out : moves out focus for time « Focus Timer »
3.8.1.b Focus Timer: Tested User ca define focus action time in ms :
3.8.1.c Mode: Tested A set of three radio buttons : - Halt - Slow - Fast User can select controller’s predefined focuser speeds Instrument Neutral Distributed Interface (INDI) Page 28/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.9 Firmware Data Instrument Neutral Distributed Interface (INDI) Page 29/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.9.1 Firmware data usage
3.9.1.a Firmware Info: Tested At connection, the driver collects and displays the following firmware information from the controller : - Date : Firmware Build Date - Firmware Build Time - Firmware Version Number - Firmware Name Instrument Neutral Distributed Interface (INDI) Page 30/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.10 Library Instrument Neutral Distributed Interface (INDI) Page 31/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.10.1 Library usage This covers Indi standard of handling catalogs … OnStep use different one that even I did not yet understand, to be done
3.10.1.a Solar System:Untested blabla
3.10.1.b Star Catalogs:Untested :
3.10.1.c Deep Sky Catalogs:Untested :
3.10.1.d Object Number:Untested : Instrument Neutral Distributed Interface (INDI) Page 32/33 OnStep Telescope Driver Version: 1.4 Date: 01/29/18
3.11 OnStep Status Instrument Neutral Distributed Interface (INDI) Page 33/33 OnStep Telescope Driver Version: 1.4 Date : 01/29/18
3.11.1 OnStep Status usage This Status Tab provides all information returned by the controller. Not yet refreshing, to be done
3.11.1.a :GU# Return: Tested Returns the controller error raw code that is parsed in the following
3.11.1.b Tracking: Tested Tracking Status :
3.11.1.c Refractoring: Tested Refractoring Status :
3.11.1.d Park: Tested Parking Status :
3.11.1.e Pec: Tested Pec Status :
3.11.1.f TimeSync: Tested Time Synchronization Status :
3.11.1.g Mount Type: Tested Mount Type :
3.11.1.h Error: Tested Last Error Code :