Differences

This shows you the differences between two versions of the page.

--- en:documentation:server_commands [2014/09/30 07:26] – [Chart Commands] pch
+++ en:documentation:server_commands [2022/12/08 09:56] (current) – [Chart drawing] pch
@@ Line 12: / Line 12: @@
 You can use any socket library or object to connect to Skychart from your software, or use the commands telnet or netcat from a script.\\
-For examples with various languages, see http://skychart.svn.sourceforge.net/viewvc/skychart/trunk/skychart/sample_client/
+To send a command, write to the socket the command, any parameter separated by a blank space, and finally a CR-LF termination.\\
+For examples with various languages, see https://github.com/pchev/skychart/tree/master/skychart/sample_client
 The standard port is 3292, this can be changed by the user in the configuration menu. The program can also choose to listen to another random port if the configured port is busy.
@@ Line 25: / Line 26: @@
-===== Main Commands =====
+===== Global Commands =====
 ^ Command ^ Parameters ^ Comment or GUI Equivalent ^
+| ?  |  | No GUI equivalent, list the available commands |
 | NEWCHART | chart_name | File -> New Chart |
 | CLOSECHART | chart_name | File -> Close Chart |
 | SELECTCHART | chart_name | Window -> chart_name |
 | LISTCHART |  | Window |
-| SEARCH | object_name | Search tool (Main Bar) |
-| GETMSGBOX |  | Returns the status bar content |
-| GETCOORBOX |  | Returns the coordinates shown in the status bar |
-| GETINFOBOX |  | Setup -> Display -> Labels - Display the chart information in the menu bar |
-| FIND  | object_class object_name | Same as search, but lets you specify the class of object you want: 0=nebula, 1=na, 2=star, 3=star, 4=variable, 5=double, 6=comet, 7=asteroid, 8=planet, 9=constellation, 10=line catalog |
 | SAVE  | saved_file_name | Save the current chart to the specified file |
 | LOAD  | saved_file_name | Load the chart from the file |
 | LOADDEFAULT | option_file_name | Use this command to load an extract of the configuration file that temporarily replace some option from skychart.ini. |
 | SETCAT  | path shortname active min max | Add or change a Catgen catalog. The fields are the same as in the [[catalog#catalog1|catalog setup]]. |
-| SHUTDOWN  | | Close the program  |
+| LOADMPCORB | file_name | Load the specified file with asteroid element in MPCORB format. Detail result is available in file [[directories_and_files|[user_data]]]/database/LoadAsteroidFile.log |
+| PLANETINFO |page_number | Open the Solar system information window at the given page |
+| GETMSGBOX |  | Returns the status bar content |
+| GETCOORBOX |  | Returns the coordinates shown in the status bar |
+| GETINFOBOX |  | Setup -> Display -> Labels - Display the chart information in the menu bar |
 | RESET | | Reload the default chart and options (same as signal HUP)|
-| ?  |  | No GUI equivalent, list of available commands |
+| SHUTDOWN  | | Close the program  |
@@ Line 49: / Line 50: @@
 ===== Chart Commands =====
 ^ Command ^ Parameters ^ Comment or GUI Equivalent ^
+| REDRAW |  | Follows a modification command, mandatory to update chart |
 | ZOOM+ |  | View -> Zoom in |
 | ZOOM- |  | View -> Zoom out |
+| ZOOM+MOVE |  | Right-clic -> Zoom + Move |
+| ZOOM-MOVE |  | Right-clic -> Zoom - Move |
 | MOVEEAST |  | Keyboard Left arrow |
 | MOVEWEST |  | Keyboard Right arrow |
@@ Line 59: / Line 63: @@
 | MOVESOUTHEAST |  | Numpad 1 (Ver num off) |
 | MOVESOUTHWEST |  | Numpad 3 (Ver num off) |
+| SETNORTH |  | Chart -> View Horizon -> North |
+| SETSOUTH |  | Chart -> View Horizon -> South |
+| SETEAST |  | Chart -> View Horizon -> East |
+| SETWEST |  | Chart -> View Horizon -> West |
+| SETZENITH |  | {{en:documentation:i41.png|}} View zenith |
+| ALLSKY |  | {{en:documentation:i42.png|}} Show all sky |
 | FLIPX |  | Chart > Tranformation > Mirror Horizontally |
 | FLIPY |  | Chart > Tranformation > Mirror Vertically |
-| SETCURSOR | pixX pixY |  |
-| CENTRECURSOR |  | Right-clic -> Center |
-| ZOOM+MOVE |  | Right-clic -> Zoom + Move |
-| ZOOM-MOVE |  | Right-clic -> Zoom - Move |
 | ROT+ |  | Chart -> Tranformation -> Rotate Right |
 | ROT- |  | Chart -> Tranformation -> Rotate Left |
-| SETEQGRID | ON/OFF | Chart -> Lines, Grid -> Add Equatorial Grid |
+| SETFOV | 00d00m00s or 00.00 | {{en:documentation:i78.png|}} Chart FOV input fields or {{en:documentation:i6.png|}} icon (Main Bar) |
-| SETGRID | ON/OFF | Chart -> Lines, Grid -> Show Coordinate Grid |
+| SETFIELDNUMBER | 1..10 | Set the FOV to one of the predefined field number |
-| SETSTARMODE | 0/1/2 | Setup -> Display -> Display -> Star Display |
+| GETFOV | S/F |  |
-| SETNEBMODE | 0/1 | Setup > Display -> Display -> Deep Sky Objects Display |
+| SETRA | RA:00h00m00s or 00.00 | {{en:documentation:i78.png|}} Chart center RA |
-| SETAUTOSKY | ON/OFF | Setup ->  Display -> Sky Colour |
+| GETRA | S/F | Chart center RA, S -> 17h07m12s\\ F -> 17.11991  |
-| UNDO |  | Edit -> Undo |
+| SETDEC | DEC:+00d00m00s or 00.00 | {{en:documentation:i78.png|}} Chart center DEC |
-| REDO |  | Edit -> Redo |
+| GETDEC | S/F |  Chart center RA |
-| SETPROJ | ALTAZ/EQUAT/GALACTIC/ECLIPTIC | Chart -> Chart Coordinate System |
+| SETOBS | LAT:+00d00m00sLON:+000d00m00s ALT:000mOBS:name | Setup -> Observatory\\ Beware the longitude must be negative East. In many case you must change the longitude sign.|
-| SETFOV | 00d00m00s or 00.00 | {{en:documentation:i78.png|}} Icon (FOV input fields) or {{en:documentation:i6.png|}} icon (Main Bar) |
+| GETOBS | LAT:+00d00m00sLON:+000d00m00s ALT:000mOBS:name | Beware the longitude is negative East. In many case you must change the longitude sign. |
-| SETRA | RA:00h00m00s or RA:00.00 | {{en:documentation:i78.png|}} Icon (RA input fields) |
+| SETDATE | yyyy-mm-ddThh:mm:ss or "yyyy-mm-dd hh:mm:ss" | Setup -> Date/Time |
-| SETDEC | DEC:+00d00m00s or DEC:00.00 | {{en:documentation:i78.png|}} Icon (DEC input fields) |
+| GETDATE |  |  |
-| SETOBS | LAT:+00d00m00sLON:+000d00m00sALT:000mOBS:name | Setup -> Observatory |
+| SETTZ | Etc/GMT | Setup -> Observatory (Country Timezone) |
-| IDCURSOR |  |  |
+| GETTZ |  |  |
+| RESIZE | width height | Resize the chart |
+| SETCURSOR | pixX pixY | Set the cursor position at the x,y coordinates |
+| GETCURSOR |  | Current cursor x,y coordinates |
+| CENTRECURSOR |  | center the chart atthe cursor position, Right-clic -> Center |
 | SAVEIMG | PNG/JPEG/BMP filename quality | File -> Save Image... |
 | PRINT | PRT/PS/BMP PORTRAIT/LANDSCAPE COLOR/BW filepath | Print or export to Postscript or Bitmap,\\ File -> Print and File-> Printer setup |
-| SETNORTH |  | Chart -> View Horizon -> North |
+| UNDO |  | Edit -> Undo |
-| SETSOUTH |  | Chart -> View Horizon -> South |
+| REDO |  | Edit -> Redo |
-| SETEAST |  | Chart -> View Horizon -> East |
-| SETWEST |  | Chart -> View Horizon -> West |
+===== Chart drawing =====
-| SETZENITH |  | {{en:documentation:i41.png|}} Icon (Right Bar) |
+^ Command ^ Parameters ^ Comment or GUI Equivalent ^
-| ALLSKY |  | {{en:documentation:i42.png|}} Icon (Right Bar) |
+| CLEANUPMAP | | Remove any selection and redraw the map |
-| REDRAW |  | Follows a modification command, mandatory to update chart |
+| SETFOVPROJECTION | fov_number HAI/MER/CAR/ARC/TAN/SIN | Set the given projection for the fov_number |
-| GETCURSOR |  |  |
+| SHOWONLYMERIDIAN | ON/OFF | Display only the meridian instead of full grid |
+| SHOWALWAYSMERIDIAN | ON/OFF | Display the meridian line on every projection |
+| SETEQGRID | ON/OFF | Chart -> Lines, Grid -> Add Equatorial Grid |
 | GETEQGRID |  |  |
+| SETGRID | ON/OFF | Chart -> Lines, Grid -> Show Coordinate Grid |
 | GETGRID |  |  |
+| SETSTARMODE | 0/1/2 | Setup -> Display -> Display -> Star Display |
 | GETSTARMODE |  |  |
+| SETNEBMODE | 0/1 | Setup > Display -> Display -> Deep Sky Objects Display |
 | GETNEBMODE |  |  |
+| SETAUTOSKY | ON/OFF | Setup ->  Display -> Sky Colour |
 | GETAUTOSKY |  |  |
+| SETPROJ | ALTAZ/EQUAT/GALACTIC/ECLIPTIC | Chart -> Chart Coordinate System |
 | GETPROJ |  |  |
-| GETFOV | S/F |  |
+| SETCHARTEQUINOX | Date/J2000 | Set the equinox when coordinate system is EQUAT |
-| GETRA | S/F | S -> 17h07m12s\\ F -> 17.11991  |
-| GETDEC | S/F |  |
-| GETDATE |  |  |
-| GETOBS |  |  |
-| SETDATE | yyyy-mm-ddThh:mm:ss or "yyyy-mm-dd hh:mm:ss" | Setup -> Date/Time |
-| SETTZ | Etc/GMT | Setup -> Observatory (Country Timezone) |
-| GETTZ |  |  |
 | SETGRIDNUM | ON/OFF | Setup -> Display -> Lines - Show Grid Label |
 | SETCONSTLINE | ON/OFF | Setup -> Display -> Lines - Show Constellation Figure |
 | SETCONSTBOUNDARY | ON/OFF | Setup -> Display -> Lines - Show Constellation Boundary |
-| RESIZE | width height | Resize the chart |
-| GETRISESET |  | Get rise/transit/set time for the last selected object |
-| MOVESCOPE | RA Dec [00.00] | Move the telescope cursor to coordinates. RA in decimal hours. |
-| MOVESCOPEH | HourAngle Dec [00.00] | Same as MOVESCOPE but hourangle instead of RA. Hourangle in decimal hours. |
-| IDCENTER | | Identify object at chart center |
-| IDSCOPE | | Identify object at telescope cursor position |
 | SHOWPICTURE | ON/OFF | Chart -> Show objects -> Show pictures |
-| SHOWBGIMAGE | ON/OFF | Show background image |
+| SHOWBGIMAGE | ON/OFF ON/OFF | Show background image, change FOV to image size |
 | LOADBGIMAGE | fits_filename | Load new background image FITS file, also force reload of updated file if the name is the same. |
 | LOADCIRCLE | file_name | Load a list of finder mark, same as right click - Finder circle - Load from file |
@@ Line 122: / Line 126: @@
 | SHOWRECTANGLE | num_list | Set a comma separated list of rectangle to be activated 1,2,...,10 |
 | MARKCENTER | ON/OFF | Show a mark at the chart center, same as Show mark |
-| GETSCOPERADEC |  | Return current telescope coordinates. |
+| GETFRAMES | | Return the mosaic frames, same as the [[mosaic tool]] "Send via server" button |
-| TRACKTELESCOPE | ON/OFF | Same as menu Telescope / Track telescope. |
+| PLANISPHEREDATE | ON/OFF | Show or hide the planisphere date scale |
-| CONNECTINDI |  | Connect to configured INDI telescope. |
+| PLANISPHERETIME | ON/OFF | Show or hide the planisphere time scale |
-| DISCONNECTINDI |  | Disconnect the INDI telescope. |
-| SLEWINDI | RAhr Dec [in decimal] | Slew the INDI telescope to specified coordinates. |
+===== Object selection =====
-| ABORTSLEWINDI |  | Abort the current slewing command. |
+^ Command ^ Parameters ^ Comment or GUI Equivalent ^
-| SYNCINDI | RAhr Dec [in decimal] | Sync the INDI telescope at the specified coordinates. |
+| GETCHARTEQSYS | | Return the current equatorial system to be used with other command. Date or J2000, B1950, ... |
+| SEARCH | object_name | Search tool (Main Bar). object_name must be enclosed in double quote if it contain space |
+| FIND  | object_class object_name | Same as search, but lets you specify the class of object you want: 0=nebula, 1=na, 2=star, 3=star, 4=variable, 5=double, 6=comet, 7=asteroid, 8=planet, 9=constellation, 10=line catalog. . object_name must be enclosed in double quote if it contain space |
+| IDCENTER | | Identify object at chart center |
+| IDCURSOR |  | Identify object at cursor position, same as click on chart |
+| IDSCOPE | | Identify object at telescope position |
+| GETSELECTEDOBJECT | | Return information about the last selected object |
+| GETRISESET |  | Get rise/transit/set time for the last selected object |
+===== Telescope =====
+^ Command ^ Parameters ^ Comment or GUI Equivalent ^
 | CONNECTTELESCOPE |  | Connect to the default telescope. |
 | DISCONNECTTELESCOPE |  | Disconnect the default telescope. |
@@ Line 134: / Line 148: @@
 | ABORTSLEW |  | Abort the current slewing command. |
 | SYNC | RAhr Dec [in decimal] | Sync the default telescope at the specified coordinates. |
-| OBSLISTLOAD | list_file_name | |
+| GETSCOPERADEC | S/F | Return current telescope coordinates, string or float format |
-| OBSLISTFIRST | | |
+| TRACKTELESCOPE | ON/OFF | Chart follow the telescope. Same as menu Telescope / Track telescope. |
-| OBSLISTLAST | | |
+| SETSCOPEREFRESHRATE | delay [ms] | Refresh the telescope position every (delay) [ms] |
-| OBSLISTNEXT | | |
+| GETSCOPERATES | | Return a list of movement rate supported by the telescope |
-| OBSLISTPREV | | |
+| SCOPEMOVEAXIS |axis(0/1) rate | Start moving the telescope along (axis) using (rate) |
-| OBSLISTLIMIT | ON/OFF | |
+^ Obsolete command specific for a INDI telescope, prefer the command above^^^
-| OBSLISTAIRMASSLIMIT | [airmass] | |
+| CONNECTINDI |  | Redirect to CONNECTTELESCOPE |
-| OBSLISTTRANSITLIMIT | [hours] | |
+| DISCONNECTINDI |  | Redirect to DISCONNECTTELESCOPE |
-| OBSLISTTRANSITSIDE | EAST/WEST/BOTH | |
+| SLEWINDI | RAhr Dec [in decimal] | Redirect to SLEW |
+| ABORTSLEWINDI |  | Redirect to ABORTSLEW |
+| SYNCINDI | RAhr Dec [in decimal] | Redirect to SYNC |
+^ This command show a cursor on the chart for a telescope not managed by Skychart^^^
+| MOVESCOPE | RA Dec [00.00] | Move the telescope cursor to coordinates. RA in decimal hours. |
+| MOVESCOPEH | HourAngle Dec [00.00] | Same as MOVESCOPE but hourangle instead of RA. Hourangle in decimal hours. |
+===== Observing list =====
+^ Command ^ Parameters ^ Comment or GUI Equivalent ^
+| OBSLISTLOAD | list_file_name | load the observing list |
+| OBSLISTFIRST | | select first object |
+| OBSLISTLAST | | select last object |
+| OBSLISTNEXT | | select next object |
+| OBSLISTPREV | | select previous object |
+| OBSLISTLIMIT | ON/OFF | set limit on/off |
+| OBSLISTAIRMASSLIMIT | [airmass] | limit by airmass |
+| OBSLISTTRANSITLIMIT | [hours] | limit by meridian distance |
+| OBSLISTTRANSITSIDE | EAST/WEST/BOTH | side of meridian |
 ===== V2.7 compatibility DDE command =====
+Avoid to use this command that exist to help the migration for older application.
 ^ Command ^ Parameters ^ Comment or GUI Equivalent ^
 | MOVE  | obsolete RA: 00h00m00.00s DEC:+00d00m00.0s FOV:+00d00m00s | {{en:documentation:i78.png|}} Icon |
@@ Line 169: / Line 203: @@
 | CONB  | obsolete, use SETCONSTBOUNDARY |  |
 | EQAZ  | obsolete, use SETPROJ |  |
+===== Information about selected object =====
+The following information are returned when an object is selected on the chart, either by a mouse click or as a result of a search. Each field is separated by the <tab> character.
+<file>> Chart_1 : 23h21m39.85s +61°19'04.8" Nb  NGC 7635 m:11.00 Dim: 15.0 x  8.0 ' class:  Identifier:C11,LBN 548</file>
+  * **>** indicate the start of a message.
+  * **Chart_1 :** the name of the chart the object was selected.
+  * **23h21m39.85s** RA of the object using current chart equinox.
+  * **+61°19'04.8"** Dec of the object using current chart equinox.
+  * **Nb** the type of object
+  * **NGC 7635** the name of the object
+Then follow a number of fields whose content depend on the object type and the catalog in use.
+If the selection is from a mouse click you can also get this information about the distance from the last selected object:
+<file>> Chart_1 : From: "Sh 2-150" to "NGC 7635 " Separation: +06°48'05.6" PA:119° Offset:  0h49m46.4s -03°53'47"</file>