Difference between revisions of "DragScript Environment Variables"

From Voyager Wiki
Jump to navigation Jump to search
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
==Voyager Remote Workspace==
+
Evironment Variables are built int variables that user cas use in DragScript without creating. Name of Environment Variables starting with $$. To help on use them there is a window list where to copy the name in the DragScript Editor.
−
Click the Remote button in the Setup workspace to display the Remote settings window, which contains miscellaneous settings about Voyager's remote operation:
 
  
−
[[File:VoagerRemoteTab.png]]
+
==Environment Variables List Form==
 +
Click on the [[File:Envvar1.png]] icon in the main menù of Viking to open the Environment Variables List:
  
 +
[[File:Evlist.png]]
  
−
==Application Server Authentication==
+
* '''Label''':  name of Variable to use in DragScript
−
The Application Server Authentication panel of the Voyager Remote workspace contains parameters for the Authentication metod used by [[Application Server API|Application Server]] to allow remote connections:
+
* '''Type:''' type of DragScript variable
 +
* '''Group:''' label to identify a group / category of environment
 +
* '''Description:''' description of the variable meaning and definitio on various values if needed
 +
* '''Copy:''' to copy in clipboard the variable label for using in DragScript various blocks configuration<br />
  
−
[[File:RemoteASAuth.png]]
+
==Environment Variables List==
−
*'''None''':  Autenthication will not be done, access to Application server is free.
+
{| class="wikitable"
−
*'''User Password''':  Access to Application Server need an authentication with username and password, not other ways are allowed. Credential is store in Voyager actually loaded profile.
+
|$$EMEVENT_EXIT_LASTREASON
−
*'''Authentication Ticket''':  A special ticket made by encrypted file or OTP code is needed to access to Application Server (reserved to renting features) and not other ways are allowed.
+
|Copy
−
*'''Authentication Ticket or User Password''':  Application Server access will be authorized or using the username and passord or ticket/OTP code
+
|String
 +
|Emergency Events
 +
|Last Reason (Source and weather string) of an EXIT Emergency Event if occourred since Voyager is started (string)
 +
|-
 +
|$$EMEVENT_EXIT_LASTTIME
 +
|Copy
 +
|String
 +
|Emergency Events
 +
|Last DateTime of an EXIT Emergency Event if occourred since Voyager is started (string)
 +
|-
 +
|$$EMEVENT_SUSPEND_LASTREASON
 +
|Copy
 +
|String
 +
|Emergency Events
 +
|Last Reason (Source and weather string) of an SUSPEND Emergency Event if occourred since Voyager is started (string)
 +
|-
 +
|$$EMEVENT_SUSPEND_LASTTIME
 +
|Copy
 +
|String
 +
|Emergency Events
 +
|Last DateTime of an SUSPEND Emergency Event if occourred since Voyager is started (string)
 +
|-
 +
|$$PERSEUS_FIRMWARE
 +
|Copy
 +
|String
 +
|OPTEC Perseus
 +
|Firmware Version
 +
|-
 +
|$$PERSEUS_ISHOMED
 +
|Copy
 +
|Counter
 +
|OPTEC Perseus
 +
|Report if Device is Homed (0=false, 1=true, -1=error)
 +
|-
 +
|$$PERSEUS_PORT
 +
|Copy
 +
|Counter
 +
|OPTEC Perseus
 +
|Actual Selected Port (0=error, X=port index from 1 to 4)
 +
|-
 +
|$$PERSEUS_PORT1NAME
 +
|Copy
 +
|String
 +
|OPTEC Perseus
 +
|Port 1 Name
 +
|-
 +
|$$PERSEUS_PORT2NAME
 +
|Copy
 +
|String
 +
|OPTEC Perseus
 +
|Port 2 Name
 +
|-
 +
|$$PERSEUS_PORT3NAME
 +
|Copy
 +
|String
 +
|OPTEC Perseus
 +
|Port 3 Name
 +
|-
 +
|$$PERSEUS_PORT4NAME
 +
|Copy
 +
|String
 +
|OPTEC Perseus
 +
|Port 4 Name
 +
|-
 +
|$$SEQUENCE_FAIL_STATUS
 +
|Copy
 +
|Counter
 +
|Sequence
 +
|Reason why the last executed sequence in DragScript exit out due to an error
 +
<code>NO_ERROR = 0</code>
  
 +
<code>UNKNOW_ERROR = 1</code>   
  
−
{{Note|Authentication for local PC Voyager's applications is not required also if set up. Voyager external application like FITViewer continue to work without need to asking auth stuff.}}
+
<code>START_ERROR = 2</code>   
  
 +
<code>SETUP_NOT_CONNECTED = 3</code>   
  
−
{{Note|Change to all setting in this box need a Voyager restart to be applied}}
+
<code>CANNOT_LOAD_SEQUENCE_FILE = 4</code>   
  
 +
<code>TARGET_POINTING_DATA_ERROR = 5</code>   
  
−
==Remote Service Allowed==
+
<code>TIME_START_END_CALCULATION_ERROR = 6</code>   
−
The Remote Service Allowed panel of the Voyager Remote workspace contains parameters for enable/disable fruition of Voyager's remote services:
 
  
−
[[File:RemoteServicesPanel.png]]
+
<code>NO_NIGHT_CONDITION = 7</code>   
−
*'''Allow Web Dashboard''':  if checked Voyager allow external client to connect to Application Server in Web Dashboard mode. Normal Client are always allowed and cannot be disabled if not stopping the [https://wiki.starkeeper.it/index.php/Voyager_Setup#Application_Server application server service] . If checked, allow also the [https://www.starkeeper.it/wdashinfo/ Voyager Web Dashboard] service to operate
 
−
*'''Allow Renting''':  if checked allow external client to connect to Application Server in Renting mode. This service need a special Plugin. For more info please contact directly [https://software.starkeeper.it Voyager staff]
 
  
 +
<code>INTERNAL_ERROR = 8</code> 
  
−
{{Note|Change to all setting in this box need a Voyager restart to be applied}}
+
<code>GUIDE_CALIBRATION_ERROR = 9</code>   
  
 +
<code>PRECISE_POINTING_ERROR = 10</code>   
  
−
==Default Remote User==
+
<code>ACQUIRE_GUIDE_STAR_ERROR = 11</code> 
−
The Default Remote User panel of the Voyager remote workspace contains parameters for authentication of Application Server remote clients:
 
  
−
[[File:DefaultRemoteUser.png]]
+
<code>MERIDIAN_FLIP_WATCHDOG_RETRY_END = 12</code> 
  
−
*'''Username''': case sensitive username required to access to the Application Server from external client, if Authentication level need Username and Password
+
<code>START_GUIDING_RETRY_END_ERROR = 13</code>  
−
*'''Password''':  case sensitive password required to access to the Application Server from external client, if Authentication level need Username and Password
 
−
*'''Apply:''' press the button to apply changes
 
  
 +
<code>FSM_UNKNOW_STATUS = 14</code> 
  
−
{{Note|Default credentials are
+
<code>TELESCOPE_NOT_CONFIGURED_CONNECTED_ERROR = 15</code> 
  
−
admin
+
<code>CAMERA_NOT_CONFIGURED_CONNECTED_ERROR = 16</code>
−
password
 
  
−
Please change it immediately !!!}}
+
<code>ROTATOR_NOT_CONFIGURED_CONNECTED_ERROR = 17</code> 
  
 +
<code>GUIDE_NOT_CONFIGURED_CONNECTED_ERROR = 18</code>
  
−
{{Note|Just define username and passowrd is not enough to protect application server Authentication. You need also to activate authentication using the Application Server Authentication panel settings}}
+
<code>GUIDE_EMPASS_ERROR = 19</code>   
  
 +
<code>GUIDE_BINNING_NOT_SUPPORTED_ERROR = 20</code> 
  
−
{{Note|credentials are stored in the actual profile. So you can have more profiles with different credentials.}}
+
<code>SEQUENCE_EMPTY_ERROR = 21</code> 
  
 +
<code>SEQUENCE_NOT_PLANNED_ERROR = 22</code> 
  
−
==Renting==
+
<code>FOLDER_CREATION_ACCESS_ERROR = 23</code> 
−
Use of these features are reserved and a special Plugin is needed. For information about please contact directly [https://software.starkeeper.it Voyager staff]
+
 
 +
<code>DOME_SLAVE_ERROR = 24</code> 
 +
 
 +
<code>FLAT_DEVICE_ERROR = 25</code> 
 +
 
 +
<code>TIME_WAIT_ERROR = 26</code>   
 +
 
 +
<code>EXEC_EXTERNAL_ERROR = 27</code> 
 +
 
 +
<code>COOLING_ERROR = 28</code> 
 +
 
 +
<code>DONUTS_ERROR = 29</code> 
 +
 
 +
<code>GUIDE_RESET_ERROR = 30</code> 
 +
 
 +
<code>GOTO_ERROR = 31</code> 
 +
 
 +
<code>ROTATOR_ERROR = 32</code> 
 +
 
 +
<code>AUTOFOCUS_ERROR = 33</code> 
 +
 
 +
<code>GUIDE_START_ERROR = 34</code>   
 +
 
 +
<code>MOUNT_PARKED_ERROR = 35</code> 
 +
 
 +
<code>MOUNT_TRACKING_STOPPED_WATCHDOG_RETRY_END = 36</code> 
 +
 
 +
<code>CAMERA_SHOT_ERROR = 37</code> 
 +
 
 +
<code>DITHERING_ERROR = 38</code> 
 +
 
 +
<code>GUIDE_STOP_ERROR = 39</code> 
 +
 
 +
<code>GOODNIGHT_ERROR = 40</code>
 +
 
 +
<code>FILTER_WRONG_INDE X= 41</code>
 +
 
 +
<code>DYNAMIC_COORDS_NEW_ERROR = 42</code>
 +
 
 +
<code>DYNAMIC_COORDS_INIT_ERROR = 43</code>
 +
 
 +
<code>DYNAMIC_COORDS_CANNOT_CALCULATE_ERROR = 44</code>
 +
 
 +
<code>DYNAMIC_COORDS_CANNOT_ASK_IFCALCULATE_ERROR = 45</code>
 +
|-
 +
|$$SVOYAGER_PROFILE_NAME
 +
|Copy
 +
|String
 +
|Voyager
 +
|Actually loaded Profile Name in Voyager
 +
|}
 +
The variables start with $$RTEVENT.... are dedicated to Voyager Advanced and Full version. Refer to the dedicated documentation.
 
*
 
*
 +
[[Category:DragScript]]
 +
[[Category:All]]
 +
[[Category:Manual|L]]

Latest revision as of 16:11, 29 May 2023

Evironment Variables are built int variables that user cas use in DragScript without creating. Name of Environment Variables starting with $$. To help on use them there is a window list where to copy the name in the DragScript Editor.

Environment Variables List Form

Click on the Envvar1.png icon in the main menù of Viking to open the Environment Variables List:

Evlist.png

  • Label: name of Variable to use in DragScript
  • Type: type of DragScript variable
  • Group: label to identify a group / category of environment
  • Description: description of the variable meaning and definitio on various values if needed
  • Copy: to copy in clipboard the variable label for using in DragScript various blocks configuration

Environment Variables List

$$EMEVENT_EXIT_LASTREASON Copy String Emergency Events Last Reason (Source and weather string) of an EXIT Emergency Event if occourred since Voyager is started (string)
$$EMEVENT_EXIT_LASTTIME Copy String Emergency Events Last DateTime of an EXIT Emergency Event if occourred since Voyager is started (string)
$$EMEVENT_SUSPEND_LASTREASON Copy String Emergency Events Last Reason (Source and weather string) of an SUSPEND Emergency Event if occourred since Voyager is started (string)
$$EMEVENT_SUSPEND_LASTTIME Copy String Emergency Events Last DateTime of an SUSPEND Emergency Event if occourred since Voyager is started (string)
$$PERSEUS_FIRMWARE Copy String OPTEC Perseus Firmware Version
$$PERSEUS_ISHOMED Copy Counter OPTEC Perseus Report if Device is Homed (0=false, 1=true, -1=error)
$$PERSEUS_PORT Copy Counter OPTEC Perseus Actual Selected Port (0=error, X=port index from 1 to 4)
$$PERSEUS_PORT1NAME Copy String OPTEC Perseus Port 1 Name
$$PERSEUS_PORT2NAME Copy String OPTEC Perseus Port 2 Name
$$PERSEUS_PORT3NAME Copy String OPTEC Perseus Port 3 Name
$$PERSEUS_PORT4NAME Copy String OPTEC Perseus Port 4 Name
$$SEQUENCE_FAIL_STATUS Copy Counter Sequence Reason why the last executed sequence in DragScript exit out due to an error

NO_ERROR = 0

UNKNOW_ERROR = 1

START_ERROR = 2

SETUP_NOT_CONNECTED = 3

CANNOT_LOAD_SEQUENCE_FILE = 4

TARGET_POINTING_DATA_ERROR = 5

TIME_START_END_CALCULATION_ERROR = 6

NO_NIGHT_CONDITION = 7

INTERNAL_ERROR = 8

GUIDE_CALIBRATION_ERROR = 9

PRECISE_POINTING_ERROR = 10

ACQUIRE_GUIDE_STAR_ERROR = 11

MERIDIAN_FLIP_WATCHDOG_RETRY_END = 12

START_GUIDING_RETRY_END_ERROR = 13

FSM_UNKNOW_STATUS = 14

TELESCOPE_NOT_CONFIGURED_CONNECTED_ERROR = 15

CAMERA_NOT_CONFIGURED_CONNECTED_ERROR = 16

ROTATOR_NOT_CONFIGURED_CONNECTED_ERROR = 17

GUIDE_NOT_CONFIGURED_CONNECTED_ERROR = 18

GUIDE_EMPASS_ERROR = 19

GUIDE_BINNING_NOT_SUPPORTED_ERROR = 20

SEQUENCE_EMPTY_ERROR = 21

SEQUENCE_NOT_PLANNED_ERROR = 22

FOLDER_CREATION_ACCESS_ERROR = 23

DOME_SLAVE_ERROR = 24

FLAT_DEVICE_ERROR = 25

TIME_WAIT_ERROR = 26

EXEC_EXTERNAL_ERROR = 27

COOLING_ERROR = 28

DONUTS_ERROR = 29

GUIDE_RESET_ERROR = 30

GOTO_ERROR = 31

ROTATOR_ERROR = 32

AUTOFOCUS_ERROR = 33

GUIDE_START_ERROR = 34

MOUNT_PARKED_ERROR = 35

MOUNT_TRACKING_STOPPED_WATCHDOG_RETRY_END = 36

CAMERA_SHOT_ERROR = 37

DITHERING_ERROR = 38

GUIDE_STOP_ERROR = 39

GOODNIGHT_ERROR = 40

FILTER_WRONG_INDE X= 41

DYNAMIC_COORDS_NEW_ERROR = 42

DYNAMIC_COORDS_INIT_ERROR = 43

DYNAMIC_COORDS_CANNOT_CALCULATE_ERROR = 44

DYNAMIC_COORDS_CANNOT_ASK_IFCALCULATE_ERROR = 45

$$SVOYAGER_PROFILE_NAME Copy String Voyager Actually loaded Profile Name in Voyager

The variables start with $$RTEVENT.... are dedicated to Voyager Advanced and Full version. Refer to the dedicated documentation.

Retrieved from "https://wiki.starkeeper.it/index.php?title=DragScript_Environment_Variables&oldid=6503"