Difference between revisions of "DragScript Environment Variables"

From Voyager Wiki
Jump to navigation Jump to search
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
These DragScript elements control the flow of execution through your script. You can use the DragScript Simulator to test how control will flow when the DragScript actions complete with OK, ERROR or TIMEOUT status, and when Emergency Suspend, Resume and Exit events happen.
+
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.
  
−
== Contents ==
+
==Environment Variables List Form==
 +
Click on the [[File:Envvar1.png]] icon in the main menù of Viking to open the Environment Variables List:
  
−
* 1 Variables
+
[[File:Evlist.png]]
−
** 1.1 '''Type'''
 
−
** 1.2 Manage
 
−
* 2 Jumps
 
−
* 3 Repeats
 
−
* 4 Decisions
 
−
** 4.1 '''Action Results''':
 
−
** 4.2 '''Operating Conditions:'''
 
−
** 4.3 '''Voyager Environment:'''
 
−
** 4.4 '''Variable Check'''
 
−
* 5 Events
 
−
** 5.1 '''Manage'''
 
−
** 5.2 '''Raise'''
 
−
** 5.3 '''Remote'''
 
−
** 5.4 '''Various'''
 
−
* 6 Block
 
−
* 7 Remark
 
−
* 8 Flow
 
  
−
== Variables ==
+
* '''Label''':  name of Variable to use in DragScript
−
DragScript has several variable types: counters (integers),  string variables and decimal numbers.  They must be declared with the Counter, String or Decimal Number actions before they can be used.  You can set and change their values, and then make decisions to execute DragScript actions based on their value.  For example, you may build a script that runs from zero to ten sequences based on the value of a counter variable you set at the start of the script.
+
* '''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 />
  
−
=== '''Type''' ===
+
==Environment Variables List==
 +
{| class="wikitable"
 +
|$$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
  
−
* '''Counter''': Declare a counter (integer) variable and give it an initial value. You must declare a variable before using it
+
 
 +
<code>NO_ERROR = 0</code>
 +
 
 +
<code>UNKNOW_ERROR = 1</code>   
 +
 
 +
<code>START_ERROR = 2</code>   
 +
 
 +
<code>SETUP_NOT_CONNECTED = 3</code>   
 +
 
 +
<code>CANNOT_LOAD_SEQUENCE_FILE = 4</code>   
 +
 
 +
<code>TARGET_POINTING_DATA_ERROR = 5</code>   
 +
 
 +
<code>TIME_START_END_CALCULATION_ERROR = 6</code>   
 +
 
 +
<code>NO_NIGHT_CONDITION = 7</code>   
 +
 
 +
<code>INTERNAL_ERROR = 8</code> 
 +
 
 +
<code>GUIDE_CALIBRATION_ERROR = 9</code>   
 +
 
 +
<code>PRECISE_POINTING_ERROR = 10</code>   
 +
 
 +
<code>ACQUIRE_GUIDE_STAR_ERROR = 11</code> 
 +
 
 +
<code>MERIDIAN_FLIP_WATCHDOG_RETRY_END = 12</code> 
 +
 
 +
<code>START_GUIDING_RETRY_END_ERROR = 13</code> 
 +
 
 +
<code>FSM_UNKNOW_STATUS = 14</code> 
 +
 
 +
<code>TELESCOPE_NOT_CONFIGURED_CONNECTED_ERROR = 15</code> 
 +
 
 +
<code>CAMERA_NOT_CONFIGURED_CONNECTED_ERROR = 16</code>
 +
 
 +
<code>ROTATOR_NOT_CONFIGURED_CONNECTED_ERROR = 17</code> 
 +
 
 +
<code>GUIDE_NOT_CONFIGURED_CONNECTED_ERROR = 18</code>
 +
 
 +
<code>GUIDE_EMPASS_ERROR = 19</code>   
 +
 
 +
<code>GUIDE_BINNING_NOT_SUPPORTED_ERROR = 20</code> 
 +
 
 +
<code>SEQUENCE_EMPTY_ERROR = 21</code> 
 +
 
 +
<code>SEQUENCE_NOT_PLANNED_ERROR = 22</code> 
 +
 
 +
<code>FOLDER_CREATION_ACCESS_ERROR = 23</code> 
 +
 
 +
<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_INDEX= 41</code>
 +
|}
 +
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]]

Revision as of 22:46, 26 June 2022

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_INDEX= 41

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=6367"