DragScript Flow of Control

From Voyager Wiki
Jump to navigation Jump to search

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.

Variables

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.

Dragscript-variables1.png

Type

  • Counter: Declare a counter (integer) variable and give it an initial value. You must declare a variable before using it

Dragscript-counter.png

  • Label: The name for this counter variable. There are no restrictions on length or legal characters, so just use something that makes sense for your control flow
  • Init Value: Initial value for the counter. Must be an integer between -2,000,000,000 and +2,000,000,000
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • String: Declare a string variable and give it an initial value. You must declare a variable before using it

Dragscript-string.png

  • Label: The name for this string variable
  • Init Value: Initial value for the string
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • Decimal Number: Declare a decimal number variable and give it an initial value. You must declare a variable before using it

Decimal-number.png

  • Label: The name for this decimal number variable
  • Init Value: Initial value for the decimal number - must be between the limits shown in the dialog box
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window

Manage

  • Update Counter: Update the value of a counter variable:

Dragscript-update-counter.png

  • Counter: Select the counter to update from the drop-down list. Counter variables must be declared with a Counter DragScript action before they can be updated
  • Update Type:
    • Set to: If selected, set the counter variable to the value in the Update Value field
    • Offset by: If selected, add the value in the Update Value field to the counter. The Update Value field can be negative or positive.
  • Update Value: A negative or positive integer value to either set the counter variable to or offset the counter variable by
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Update String: Update the value of a string variable:

Dragscript-update-string.png

  • String: Select the string variable to update from the drop-down list
  • Update Value: Enter the new value for the string variable
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Update Decimal Number: Update the value of a decimal number

Update-decimal-number.png

  • Decimal Number: Select the decimal number variable to update from the drop-down list
  • Update Type:
    • Set to: Set the decimal number value to the number in the Update Value field
    • Offset by: Add the +/- number in the Update Value field to the current value of the decimal number
  • Update Value: Enter the new value for the decimal number variable
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • Update Decimal Number from Camera Temperature: Set the value of a decimal number from the temperature reported from Camera Driver:
  • UpdateCameraTemp.png
  • Decimal Number: Select the decimal number variable to update from the drop-down list
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • Update Decimal Number from Observing Conditions: Set the value of a decimal number from the observing conditions returned from I/O cards via Viking or from an ASCOM Observing Conditions driver:

Update-decimal-from-condx.png

  • Decimal Number: Select the decimal number variable to update from the drop-down list
  • Observing Condition: Select the observing condition whose value should be placed into the decimal number. These values come from Viking, a companion product from Starkeeper.it or from an ASCOM Observing Conditions driver
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • Update Decimal from Unix TimeStamp GMT: Set the value of a decimal number from the UNIX TimeStamp GMT based (seconds from 1/1/1970 UTC 0:0:0

Immaginergbrbrb.png

  • Decimal Number: Select the decimal number variable to update from the drop-down list
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Update Decimal Number from Focuser Temperature: Set the value of a decimal number from the temperature returned by the focuser or auto-focus system

Update-decimal-from-focus-temp.png

  • Decimal Number: Select the decimal number variable to update from the drop-down list
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Update Decimal Number with Autofocus HFD: Set the value of a decimal number with the final HFD (Half Flux Diameter) value from the last autofocus operation

Update-decimal-hfd.png

  • Decimal Number: Select the decimal number variable to update from the drop-down list
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
    Important Note! At this time only RoboFire LocalField, RoboStar, and FocusMax return the HFD value - if you use a different autofocus routine, the HFD is not available


  • Update Decimal from Focuser Position: Set the value of a decimal number from the actual position returned by the RoboFire focuser

Update-decimal-from-focus-temp.png

  • Decimal Number: Select the decimal number variable to update from the drop-down list
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Update Decimal from Solved PA: Set the value of a decimal number from the last solved PA returned by a Plate or Blind Solving action

UpdataFromPA.png

  • Decimal Number: Select the decimal number variable to update from the drop-down list
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • Update Decimal from Rotator PA: Set the value of a decimal number from the Rotator PA returned by Rotator driver

UpdateRotPA.png

  • Decimal Number: Select the decimal number variable to update from the drop-down list
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Multiply Decimal Number: Multiply a decimal number variable for the value in another variable of type counter or decimal or by direct value, the result will be stored in replace of actual value

DSMultiplyDecNum.png

  • Decimal Number: Select the decimal number variable to multiply and update
  • Multiply by Decimal Variable: Select the decimal number variable to use for multiply
  • Multiply by Counter Variable: Select the counter variable to use for multiply
  • Multiply by Value: Select the direct value to use for multipy
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Divide Decimal Number: Divide a decimal number variable for the value in another variable of type counter or decimal or by direct value, the result will be stored in replace of actual valueImmagineerfegwegwewegweg.png
    • Decimal Number: Select the decimal number variable to divide and update
    • Divide by Decimal Variable: Select the decimal number variable to use for divide
    • Divide by Counter Variable: Select the counter variable to use for divide
    • Divide by Value: Select the direct value to use for divide
    • OK: Save changes and close the window
    • Cancel: Discard changes and close the window


  • Add to Decimal Number: Add a decimal number variable for the value in another variable of type counter or decimal or by direct value, the result will be stored in replace of actual valueImmaginevpomebmob.png
    • Decimal Number: Select the decimal number variable to add and update
    • Add by Decimal Variable: Select the decimal number variable to use for add
    • Add by Counter Variable: Select the counter variable to use for add
    • Add by Value: Select the direct value to use for add
    • OK: Save changes and close the window
    • Cancel: Discard changes and close the window


  • Subtract to Decimal Number: Subtract a decimal number variable for the value in another variable of type counter or decimal or by direct value, the result will be stored in replace of actual valueImmagineiloiliolio.png
    • Decimal Number: Select the decimal number variable to subtract and update
    • Subtract by Decimal Variable: Select the decimal number variable to use for subtract
    • Subtract by Counter Variable: Select the counter variable to use for subtract
    • Subtract by Value: Select the direct value to use for subtract
    • OK: Save changes and close the window
    • Cancel: Discard changes and close the window


  • Add to Counter: Add a counter variable for the value in another variable of type counter or decimal or by direct value, the result will be stored in replace of actual valueImmaginetntynty.png
    • Counter: Select the counter variable to add and update
    • Add Decimal Variable: Select the decimal number variable to use for add
    • Add Counter Variable: Select the counter variable to use for add
    • Add Value: Select the direct value to use for add
    • OK: Save changes and close the window
    • Cancel: Discard changes and close the window


  • Subtract to Counter: Subtract a counter variable for the value in another variable of type counter or decimal or by direct value, the result will be stored in replace of actual valueImmaginedfdfbdf.png
    • Counter: Select the counter variable to subtract and update
    • Subtract Decimal Variable: Select the decimal number variable to use for subtract
    • Subtract Counter Variable: Select the counter variable to use for subtract
    • Subtract Value: Select the direct value to use for subtract
    • OK: Save changes and close the window
    • Cancel: Discard changes and close the window

Jumps

Jumps are used to goto a specified block of the DragScript. You can jump to the Start, End or a named Block.

Dragscript-jumps.png

  • Goto Start: Jump to the Start block of the script
  • Goto Block: Jump to a named block in the script

Dragscript-block-goto.png

  • Block: Select the named from the drop-down list, or type in the name of a block
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Goto End: Jump to the End block of the script


Repeats

Repeats are used to execute a DragScript block a specified number of times, or until a specific time, or until astronomical night ends.

Repeats must be placed inside a block (note: Script: is a special block that contains the entire script.

If the result of evaluating a Repeat is to repeat the block, control returns to the block statement that contains the repeat.

Dragscript-repeats.png

  • Repeat Block for n Times: Repeat the containing block a specified number of times

Dragscript-repeat-block.png

  • Times: Number of times to repeat this block
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • Repeat Current Block Until Time: Repeat the contained block until the specified time:

Dragscript-until-time.png

  • Time: Repeat the current block until this time
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • Repeat Block Until Astronomical/Nautical/Civil Night End:

Dragscript-repeat-until-night-end.png

  • Get Latitude and Longitude from Mount: Retrieve the current latitude and longitude from the connected mount, which must support this command. This location is used, along with the current date, to determine the time that astronomical/nautical/civil night ends
  • Use the Latitude and Longitude indicated below: Specify your current latitude and longitude in the fields below. This location is used, along with the current date, to determine the time that astronomical/nautical/civil night ends
  • Offset: Time in HH MM SS
    • Offset Before: If selected, repeat the block until this amount of time before astronomical/nautical/civil night ends
    • Offset After: If selected, repeat the block this amount of time after astronomical/nautical/civil night ends
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


Important Note! The time will be considered to have been reached if it is within 12 hours of the current time when the check is performed. E.g., if we set a repeat until 05:00, if it is 23:30 the repeat will be done since 23:30 is more than 12 hours in the future and less than 12 hours in the past, relative to 05:00. If it is 11:00, the repeat will be skipped, since 11:00 is later than 05:00 and more than 12 hours in the past.


Decisions

Decisions control the flow of your DragScript based on the results of an action (OK, ERROR, TIMEOUT), operating conditions (current time, date or target altitude), or the value of a variable.

Important Note! A Decision element will create a new indent level in your DragScript. Drag new elements and drop them on the Decision element, or copy and paste them to it, to have their execution controlled by the result of the Decision


Dragscript-decisions-2.1.7s.jpg

Action Results:

Do the actions at the indent level created by the Decision block based on the results of the action preceding the decision

    • IF OK: Do the actions following this statement if the result of the previous action was OK - meaning the action was successful
    • IF ERROR: Do the actions following this statement if the result of the previous action was ERROR - meaning the action failed
    • IF TIMEOUT: Do the actions following this statement if the result of the previous action was a TIMEOUT - meaning the action reached a specified timeout value without succeeding
    • IF SKIPPED: Do the actions following this statement if the skipped status of the previuos action was SKIPPED - meaning the action not generate ERROR or finish OK just is SKIPPED because some constraints isnìt possible to match. At now only the Sequence Action use the SKIPPED status if time wait or time end or one of the constraints in azimuth, hour agle, alitute was thrown

Operating Conditions:

Do the actions at the indent level created by the Decision block based on the time, date or target altitude

  • DO IF ALTITUDE: Do the actions if a target specified by RA and DEC coordinates has risen above or set below a specified altitude:

Dragscript-do-if-altitude.png

  • RA Target J2000: RA coordinates of the object you want to reach the Reference Altitude in HH MM SS or HH MM SS.sss
  • DEC Target J2000: DEC coordinates of the object you want to reach the Reference Altitude in DD MM SS or DD MM SS.sss
  • Reference Altitude: Altitude to reach in degrees
  • Do If Actual Altitude GREATER than or EQUAL (>=) to reference: Do the actions if the target has reached or risen above the reference altitude
  • Do If Actual Altitude LOWER than or EQUAL (>=) to reference: Do the actions if the target has reached or set below the reference altitude
  • RoboClip: load RA and DEC from RoboClip catalog
  • Coords From Sequence: load RA and DEC from a sequence file
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • DO IF ALTITUDE DYNAMIC TARGET: Do the actions if a Dynamic Target has risen above or set below a specified altitude (RA/DEC will be calculated in realtime using RoboOrbits):

Immaginettg.png

  • Comet : open the Comet Finder in RoboOrbits, see more here
  • Asteroid : open the Asteroid Finder in RoboOrbits, see more here
  • Planet: open the Planet Finder in RoboOrbits, see more here
  • Object Name : Read-only name of the Dynamic Target, coming from the search
  • Object Key : Read-only key (code/number) of the Dynamic Target, coming from the search
  • Object Dynamic Type : Read-only type of the Dynamic Target, coming from the search
  • Reference Altitude: Altitude to reach in degrees
  • Do If Actual Altitude GREATER than or EQUAL (>=) to reference: Do the actions if the target has reached or risen above the reference altitude
  • Do If Actual Altitude LOWER than or EQUAL (>=) to reference: Do the actions if the target has reached or set below the reference altitude
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • DO IF ALTITUDE BETWEEN: Do the actions if the altitude of a target specified by RA and DEC coordinates is between the Start and End values

Do-if-altitude-between.jpg

  • RA Target J2000: RA coordinates of the object you want to reach the Reference Altitude in HH MM SS or HH MM SS.sss
  • DEC Target J2000: DEC coordinates of the object you want to reach the Reference Altitude in DD MM SS or DD MM SS.sss
  • Start and End: Do the actions if the specified target's altitude is greater than or equal to the Start value and less than or equal to the End value in decimal degrees
  • RoboClip: load RA and DEC from RoboClip catalog
  • Coords From Sequence: load RA and DEC from a sequence file
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • DO IF ALTITUDE BETWEEN DYNAMIC TARGET : Do the actions if the altitude of a Dynamic Target is between the Start and End values (RA/DEC will be calculated in realtime using RoboOrbits):

Immagineefe.png

  • Comet : open the Comet Finder in RoboOrbits, see more here
  • Asteroid : open the Asteroid Finder in RoboOrbits, see more here
  • Planet: open the Planet Finder in RoboOrbits, see more here
  • Object Name : Read-only name of the Dynamic Target, coming from the search
  • Object Key : Read-only key (code/number) of the Dynamic Target, coming from the search
  • Object Dynamic Type : Read-only type of the Dynamic Target, coming from the search
  • Start and End: Do the actions if the specified target's altitude is greater than or equal to the Start value and less than or equal to the End value in decimal degrees
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window



  • DO IF AZIMUTH BETWEEN: Do the actions if the azimuth of a target specified by RA and DEC coordinates is between the Start and End values and the Altitude of the Target is above the minimum Altitude for slew set up in Voyager Mount setting (default is 0°)


Immagineyjtyj.png

  • RA Target J2000: RA coordinates of the object you want to reach the Reference Altitude in HH MM SS or HH MM SS.sss
  • DEC Target J2000: DEC coordinates of the object you want to reach the Reference Altitude in DD MM SS or DD MM SS.sss
  • Start and End: Do the actions if the specified target's azimuth is greater than or equal to the Start value and less than or equal to the End value in decimal degrees. Also the Altitude of the target must be above the minimum for a slew like set tup in Voyager Mount setting (default is 0°)
  • RoboClip: load RA and DEC from RoboClip catalog
  • Coords From Sequence: load RA and DEC from a sequence file
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


Important Note! Remember that a Target can be in the right azimuth interval but can be upside down wiht negtive altitude. DO IF will be not executed if altitude of target are under the minimum altitude value accepted for a slew in Voyager mount setting


  • DO IF AZIMUTH BETWEEN DYNAMIC TARGET : Do the actions if the azimuth of a Dynamic Target is between the Start and End values and the Altitude of the Target is above the minimum Altitude for slew set up in Voyager Mount setting (default is 0°) (RA/DEC will be calculated in realtime using RoboOrbits):

DSDoIfAzimuth.png

  • Comet : open the Comet Finder in RoboOrbits, see more here
  • Asteroid : open the Asteroid Finder in RoboOrbits, see more here
  • Planet: open the Planet Finder in RoboOrbits, see more here
  • Object Name : Read-only name of the Dynamic Target, coming from the search
  • Object Key : Read-only key (code/number) of the Dynamic Target, coming from the search
  • Object Dynamic Type : Read-only type of the Dynamic Target, coming from the search
  • Start and End: Do the actions if the specified target's azimuth is greater than or equal to the Start value and less than or equal to the End value in decimal degrees. Also the Altitude of the target must be above the minimum for a slew like set tup in Voyager Mount setting (default is 0°)
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • DO IF HA BETWEEN: Do the actions if the hour angle of the target (hours difference from the meridian) is between the specified start and end amounts Dragscript-doifha-2.1.7s.jpg
  • RA Target J2000: RA coordinates of the object whose hour angle we are testing, in HH MM SS or HH MM SS.sss
  • DEC Target J2000: DEC coordinates of the object whose hour angle we are testing, in DD MM SS or DD MM SS.sss
  • Start and End: Do the actions if the specified target's HA (hour angle) is greater than or equal to the Start value and less than or equal to the End value in decimal hours. Note the values can be positive (after the meridian) or negative (before the meridian). The start to end can be both negative, both positive, or the start can be negative and the end can be positive. In all cases, the value must increase from start to end.
  • RoboClip: load RA and DEC from RoboClip catalog
  • Coords From Sequence: load RA and DEC from a sequence file
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • DO IF HA BETWEEN DYNAMIC TARGET : Do the actions if the hour angle of the Dynamic target (hours difference from the meridian) is between the specified start and end amounts (RA/DEC will be calculated in realtime using RoboOrbits):
  • Immaginesf.png
  • Comet : open the Comet Finder in RoboOrbits, see more here
  • Asteroid : open the Asteroid Finder in RoboOrbits, see more here
  • Object Name : Read-only name of the Dynamic Target, coming from the search
  • Object Key : Read-only key (code/number) of the Dynamic Target, coming from the search
  • Object Dynamic Type : Read-only type of the Dynamic Target, coming from the search
  • Start and End: Do the actions if the specified target's HA (hour angle) is greater than or equal to the Start value and less than or equal to the End value in decimal hours. Note the values can be positive (after the meridian) or negative (before the meridian). The start to end can be both negative, both positive, or the start can be negative and the end can be positive. In all cases, the value must increase from start to end.
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
  • DO IF TIME BETWEEN: Do the actions if the time is between the specified start and end times

Dragscript-do-if-time.png

  • Start: Beginning time of interval within which to do the following actions
  • End: End time of interval within which to do the following actions
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • DO IF DATE BETWEEN: Do the actions at the indent level created by the DO statement if the date is between the start and end dates:

Dragscript-do-if-date.png

  • Start: Start date of the interval
  • End: End date of the interval
  • Default: Use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • DO IF SQM: Do the actions at the indent level created by the DO statement if the SQM value readed from control or Observing conditions is between the start and end dates:

DOIFSQM.png

  • Reference Sky Quality: reference value of Sky Quality to check
  • Do If Actual value GREATER than or EQUAL [>=] to reference: execute what is inside DO IF if the actual value >= that the reference value
  • Do If Actual value LOWER than or EQUAL [<=] to reference: execute what is inside DO IF if the actual value <= that the reference value
  • Default: use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • DO IF FOCAL LENGTH: Do the actions at the indent level created by the DO statement if the FOCAL LENGTH readed from actual profile (Setup->Camera) is >=, <= or equal to reference value:

DoIfFocalLengthBlock.jpg

  • Reference Focal Length: reference value of Telescope Focal Length to check
  • Do If Focal Length GREATER than or EQUAL [>=] to reference: execute what is inside DO IF if the actual value >= that the reference value
  • Do If Focal Length LOWER than or EQUAL [<=] to reference: execute what is inside DO IF if the actual value <= that the reference value
  • Do If Focal Length EQUAL [=] to reference: execute what is inside DO IF if the actual value = that the reference value
  • Default: use the default settings
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • DO IF DOME/ROOF OPEN: Do the actions at the indent level created by the DO statement if the DOME/ROOF is opened
  • DO IF DOME/ROOF CLOSED: Do the actions at the indent level created by the DO statement if the DOME/ROOF is closed


Important Note! Status of DOME/ROOF will be read from the DOME Control configured in Voyager. This control is not absolutely reliable at 100%. Voyager cannot responding in anycase and any mode on damage derived from use of this conditional blocks. Please instead use the I/O card system with Viking management and physycal sensors to check the real status of your dome/roof.
  • DO IF DISTRIBUITED SAFE END: Wait the end of the night like defined in the Distribuited Safe block configuration. this is a features of the Distribuited Emergency plugin dedicated to multi telscope in a single dome sharing emergency events
  • DO IF EVEN DAY: Decision block, true if the day of the month is an even number. Useful for example to do flat/calibration fit in different sets.
  • DO IF ODD DAY: Decision block, true if the day of the month is an odd number. Useful for example to do flat/calibration fit in different sets.
  • DO IF DAY OF WEEK: Decision block, true if the day of the week is one of those indicated in configuration (one or more day can be selected). Useful for example to do flat/calibration fit in different sets. Or doing some special task for copy file or etc etc
    • Immaginewerwr.png
  • DO IF PIER SIDE: Decision block, true if the pier side of the mount (what is reported by the connected driver) is equal to the parameter selected
    • Immagineevveerv.png
    • Pier West: mount before the meridian (or meridian passed but flip do not done)
    • Pier East: mount after the meridian(meridian crossed and flip done)
  • DO IF MOON PHASE: Decision Block, true if the moon phase >= or <=, depends on the selected filter to apply, of the value edited. To calculate the moon phase the mount must be connect or you must select manual data and input the LAT and LONG
    • Immagineefefwefwevvwev.png
    • Moon Phase: percentage value for reference
    • Do If Actual value is GREATER than or EQUAL [>=] to reference : itself explained
    • Do If Actual value is LOWERthan or EQUAL [<=] to reference : itself explained
    • Get Latitude and Longitude from Mount (the Setup must be connected : itself explained
    • Use Latitude and Longitude indicated below
      • Latitude: Latitude to use
      • Longitude: Longitude to use
      • Default : restore default settings
      • Cancel: close the window without doing anything, data change will be lost
      • OK: accept data and save in block configuration
    • Important Note! This block is only available and usable only if you have installed a Voyager Advanced License or a Voyager Full License. Other an error will be generate during the DragScript Execution

Voyager Environment:

Do the actions at the indent level created by the Decision block based on the Voyager internal status

  • DO IF SETUP CONNECTED: Do the actions if Voyager Setup is connected (from Startup menù or by DragScript connect block)
  • DO IF SETUP DISCONNECTED: Do the actions if Voyager Setup is not connected (from Startup menù or by DragScript disconnect block)


Variable Check

Do the actions at the indent level created by the DO IF statement based on the value of a variable. Variables must be declared before they can be tested in a DO IF statement

Decisions-variable-check.png

  • DO IF COUNTER VALUE: Check the value of a counter (integer) variable and do the following actions if the value of the counter meets the specified criteria:

Dragscript-do-if-counter.png

  • Label: Choose the counter variable to test from the drop-down list
  • is Lower than: Do the following actions if the selected counter value is less than the number in the counter field
  • is Lower than or Equal to: Do the following actions if the selected counter value is less than or equal to the number in the counter field
  • is Equal to: Do the following actions if the selected counter value is equal to the number in the counter field
  • is Greater or Equal to: Do the following actions if the selected counter value is greater than or equal to the number in the counter field
  • is Greater than: Do the following actions if the selected counter value is greater than the number in the counter field
  • is Between: Do the following actions if the selected counter value is between the values in the two counter fields (greater than or equal to the left value AND less than or equal to the right field)
  • is Not Equal to: Do the following actions if the selected counter value is not equal to the number in the counter field
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window
    • DO IF STRING VALUE: Do the actions at the indent level created by the DO IF statement if a string variable is equal to, not equal to, or contains a specified string:

Dragscript-do-if-string.png

  • Label: Choose the string variable to test from the drop-down list
  • is Equal to: Do the following actions if the selected string value is equal to the specified string
  • is Not Equal to: Do the following actions if the selected string value is not equal to the specified string
  • Contains: Do the following actions if the selected string value contains the specified string
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


Important Note! String comparisons are case sensitive, i.e. TargetName is not equal to targetname


  • DO IF DECIMAL VALUE: Do the actions at the indent level created by the DO IF statement if the value of the decimal number meets the specified criteria:

Do-if-decimal-value.png

  • Label: Choose the counter variable to test from the drop-down list
  • is Lower than: Do the following actions if the selected decimal number value is less than the number in the decimal number field
  • is Lower than or Equal to: Do the following actions if the selected decimal number value is less than or equal to the number in the decimal number field
  • is Equal to: Do the following actions if the selected decimal number value is equal to the number in the counter field
  • is Greater or Equal to: Do the following actions if the selected decimal number value is greater than or equal to the number in the decimal number field
  • is Greater than: Do the following actions if the selected decimal number value is greater than the number in the decimal number field
  • is Between: Do the following actions if the selected decimal number value is between the values in the two decimal number fields (greater than or equal to the left value AND less than or equal to the right field)
  • is Not Equal to: Do the following actions if the selected decimal number value is not equal to the number in the decimal number field
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • DO IF COUNTER VALUE (Extended): Check the value of a counter (integer) variable and do the following actions if the value of the counter meets the specified criteria extended to a value, counter or decimal value:
    • Immagineerfer.png
      • Counter: Choose the counter variable to test from the drop-down list
      • is Lower than: Do the following actions if the selected counter value is less than the number in the counter field
      • is Lower than or Equal to: Do the following actions if the selected counter value is less than or equal to the number in the value field , counter variable or decimal variable
      • is Equal to: Do the following actions if the selected counter value is equal to the number in the value field , counter variable or decimal variable
      • is Greater or Equal to: Do the following actions if the selected counter value is greater than or equal to the number in the value field , counter variable or decimal variable
      • is Greater than: Do the following actions if the selected counter value is greater than the number in the value field , counter variable or decimal variable
      • is Between: Do the following actions if the selected counter value is between the values in the value field , counter variable or decimal variable (greater than or equal to the left value AND less than or equal to the right field)
      • is Not Equal to: Do the following actions if the selected counter value is not equal to the number in the value field , counter variable or decimal variable
      • OK: Save changes and close the window
      • Cancel: Discard changes and close the window


DO IF DECIMAL VALUE (Extended): Check the value of a counter (integer) variable and do the following actions if the value of the counter meets the specified criteria extended to a value, counter or decimal value:

  • Immaginee3fer.png
    • Decimal Number: Choose the decimal variable to test from the drop-down list
    • is Lower than: Do the following actions if the selected decimal value is less than the number in the counter field
    • is Lower than or Equal to: Do the following actions if the selected decimal value is less than or equal to the number in the value field , counter variable or decimal variable
    • is Equal to: Do the following actions if the selected decimal value is equal to the number in the value field , counter variable or decimal variable
    • is Greater or Equal to: Do the following actions if the selected decimal value is greater than or equal to the number in the value field , counter variable or decimal variable
    • is Greater than: Do the following actions if the selected decimal value is greater than the number in the value field , counter variable or decimal variable
    • is Between: Do the following actions if the selected decimal value is between the values in the value field , counter variable or decimal variable (greater than or equal to the left value AND less than or equal to the right field)
    • is Not Equal to: Do the following actions if the selected decimal value is not equal to the number in the value field , counter variable or decimal variable
    • OK: Save changes and close the window
    • Cancel: Discard changes and close the window

Events

DragScript execution can be suspended, terminated (exited) and resumed based on the occurrence of Emergency Exit, Emergency Suspend and Emergency Resume events.

The most common use of Events is together with a weather monitoring system, as configured in Weather Setup. You can specify at a detailed level which events should cause DragScript execution to SUSPEND (such as overcast clouds), EXIT (such as rain), or RESUME (such as clouds moving out so it becomes clear again).

In addition to weather events, you can raise Emergency Exit, Emergency Suspend and Emergency Resume events at any point in your DragScript.

When an Event is raised, control flow goes immediately to the appropriate block (Exit, Suspend or Resume) in the Events block of your DragScript. Create those blocks by dragging elements from the Events: Manage list.

Dragscript-events.png

Manage

See the DragScript Examples section to see how these blocks work in a DragScript.

  • Emergency Exit: Drag this element to the Events block of your DragScript. Then drag the actions you wish to take place when an Emergency Exit event is raised. For example, stop tracking, stop guiding, park your mount, and close the observatory roof
  • Emergency Suspend: Drag this element to the Events block of your DragScript. Then drag the actions you wish to take place when an Emergency Suspend event is raised. For example, stop tracking and stop guiding

Dragscript-suspend-2.png

  • Wait Resume until absolute time: If the time specified in HH MM SS is reached without an Emergency Resume event being raised, perform the action selected from the radio buttons in this dialog window
  • Wait Resume for a time interval of: If the time period specified in HH MM SS elapses without an Emergency Resume event being raised, perform the action selected from the radio buttons in this dialog window
  • Wait Resume until end of Astronomical Night: If the end of Astronomical Night arrives without an Emergency Resume event being raised, perform the action selected from the radio buttons in this dialog window
  • Wait Resume until end of Nautical Night : If the end of Nautical Night arrives without an Emergency Resume event being raised, perform the action selected from the radio buttons in this dialog window
  • Wait Resume until end of Civil Night: If the end of Civil Night arrives without an Emergency Resume event being raised, perform the action selected from the radio buttons in this dialog window
  • Important Note! the various Wait Resume until end of xxxx Nights needed the specification on how to retrieve the data for the night (from Mount or by manual latitude and longitude) .
    • Get Latitude and Longitude from Mount: Retrieve the current latitude and longitude from the connected mount, which must support this command. This location is used, along with the current date, to determine the time that astronomical night begins and end. SETUP MUST BE CONNECTED TO WORK !
    • Use the Latitude and Longitude indicated below: Specify your current latitude and longitude in the fields below. This location is used, along with the current date, to determine the time that astronomical night begins and end
  • Wait Resume Until Distribuited SAFE End [Distribuited Emergency Plugin Needed]: if selected Voyager will wait for resume according the SAFE END procedure of the Distribuited Emergency Plugin. A dedicated plugin for multi pier in a single building is needed https://software.starkeeper.it/voyager-plugins/
  • On Resume Timeout End DragScript: If the time specified above is reached without an Emergency Resume event occurring, end the DragScript
  • On Resume Timeout Exec Emergency Exit Event: If the time specified above is reached without an Emergency Resume event occurring, raise an Emergency Exit event
  • On Resume Timeout Restart DragScript: If the time specified above is reached without an Emergency Resume event occurring, Voyager will restart the DragScript form beginneng like a new running
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Emergency Resume: Execute these actions when an Emergency Resume event is raised. For example, start tracking and start guiding

Raise

Raise an Emergency Exit, Suspend or Resume event

  • Raise Emergency Exit Event: Raise the Emergency Exit event. Execution of the DragScript will go immediately to the Emergency Exit block in the Events block
  • Raise Emergency Suspend Event: Raise the Emergency Suspend event. Execution of the DragScript will go immediately to the Emergency Suspend block in the Events block
  • Raise Emergency Resume Event: Raise the Emergency Resume event. Execution of the DragScript will go immediately to the Emergency Resume block in the Events block

Remote

Block for management of Distributed Distributed Emergency

  • Set Distributed Emergency Status: Update overriding the internal Distributed Emergency Status for the Voyager Client connected to the selected value
    • Des1.png
  • Distributed Safe: Distributed Safe wait the night like configured and in the night wait to have a Safe condition from the Emergency Event System (in Voyager is Weather, Safety Monitor, Viking I/O). If night is recognized and safe condition is true DragScript will exit from this block with OK result. If timeout is reached waiting DragScript will exit from this block with a TIMEOUT result. In case of error during waiting DragScript will exit with ERROR result. Checking the exit of block user can decide if inform all the client of a SAFE condition using the SET DISTRIBUTED EMERGENCY STATUS or restart the Master DragScript to wait for better conditions (same night or next night is automatically decided from DragScript). This block is usually associated and work only if you using the Distributed Emergency plugin. Right and only place where to use is the Voyager MASTER of plugin where information is processed and emergency events checked.
    • Important Note! Distributed Safe Cannot be used inside the Event Manager (Exit, Suspend, Resume)
      • DES2.png
      • NIGHT Configuration: data necessary to calculate the start and end interval of the actual night
        • Night DATA: data about location of observatory
          • Latitude: Latitude of the Mount
          • Longitude: Longitude of the Mount
        • Night TYPE: type of night to calculate. Astronomical, Nautical or Civil
        • Night START OFFSET: apply an offset to the time start of the night
          • Offset Before: offset before the start in hours, minutes and seconds
          • Offset After: offset after the start in hours, minutes and seconds
        • Night END OFFSET: apply an offset to the time end of the night
          • Offset Before: offset before the end in hours, minutes and seconds
          • Offset After: offset after the end in hours, minutes and seconds
        • EVENT CHECK options: with this option you can decide to remove from processing status of SAFE some kind of events that will be ignored (event in any case are disable during the wait safe action)
          • Check Emergency Exit Status in SAFE status calculation: if unchecked the condition that throw an Emergency Status will be ignored in calculation of SAFE Staus . ATTENTION !! this is a way really dangerous for your setup .. use only if you want to wait safe in particular condition , particular timing and for particular tasks
          • Check Emergency SUSPEND Status in SAFE status calculation: if unchecked the condition that throw an Emergency Status will be ignored in calculation of SAFE Staus . ATTENTION !! this could be a way really dangerous for your setup .. use only if you want to wait safe in particular condition , particular timing and for particular tasks.
        • LIGHT CONDITIONS options: with this option you can decide to remove from processing status of SAFE the LIGHT Conditions status
          • Remove Weather LIGHT Conditions Status From Calculation of All Emergency Status: if unchecked the LIGHT conditions from Weather system will be not used to calculate the SAFE Status. Usefull if you want to open the dome with the light approaching the night time and do skyflat. For the Dawn flat you can decide to disable the LIGHT event using dedicated block
        • Default: Use the default settings
        • OK: Save changes and close the window
        • Cancel: Discard changes and close the window

Various

  • Resume from Block: Resume execution starting with the specified block. This can only be placed in the Emergency Resume block in the Events block

Dragscript-resume-from-block.png

  • Block: Choose the block where execution should resume from the drop-down list
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


  • Disable Events: Disable event processing. Emergency Exit, Suspend and Resume events will be ignored
  • Enable Events: Enable event processing. Emergency Exit, Suspend and Resume events will be recognized and handled
  • Disable Exit Event: Disable event processing. Emergency Exit only event will be ignored
  • Enable Exit Event: Enable event processing. Emergency Exit event will be recognized and handled
  • Disable Suspend Event: Disable event processing. Emergency Suspend and Resume only events will be ignored
  • Enable Suspend Event: Enable event processing. Emergency Suspend and Resume only events will be recognized and handled
  • Disable Weather Light Event: Disable event processing of Light conditions coming from Weather System. Status of Light will be not used to processing the Emergency Exit and/or Emergency Suspend or Emergency Resume events (Work only if you have a weather system configured in Voyager)
  • Enable Weather Light Event: Enable event processing of Light conditions coming from Weather System. Status of Light will be used to processing the Emergency Exit and/or Emergency Suspend or Emergency Resume events (Work only if you have a weather system configured in Voyager)


Important Note! Enable and disable Events is a really powerful features !!! Please use with complete understand that if you forget to re-enable the events your setup can be damaged from weather conditions.


Important Note! Enable and disable Light Conditions from emergency status calculation can be useful for do SkyFlat or generally other kind of tasks at dawn and dusk or for daylight operations and testing.


Events Robotarget

If you are running a Voyager Advanced or Full version you can intercept the thrown events generated by RoboTarget Action during. This event can be annotations or errors. Data about are saved in the environment variables of DragScript and can be used in the signal block of DragScript. What is inside the Events RoboTarget Management will executed in seld contained DragScript ineriths by the actual DragScript eliminating all except what is in the events handle you have created.

To select the event handle and create it you must use the Operating Conditions blocks.


Immagineergerherherh.png

Operating Conditions

There is only one operating conditions block to handle a RoboTarget Event. The DO IF ROBOTARGER EVENT. You can use one or more of this block.

  • DO IF ROBOTARGER EVENT: Handle one or more events related to RoboTarget Action executing in a self contained ineriths dragscript the block inside the condition
  • Immaginergerwerhgwrh.png
  • Even(s) Selected: select one or more RoboTarget events to handle
  • Reset: Uncheck all the events selected and remove from handling
  • Cancel: exit from configuration without save anything
  • OK: Save changes and close the window

Block

The Block element creates a new block in your DragScript. Drag and Drop it on a DragScript element that creates a new indent level, e.g. Script, DO IF, IF, Emergency Exit, Emergency Suspend, or Emergency Resume.

Dragscript-block.png

  • Label: Give your block a name. This name can be referenced by other script elements such as jumps and resumes
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


Remark

The Remark element adds a non-executable comment to your script for documentation purposes

Dragscript-remark.png

  • Remark: Enter a comment that will appear in your script
  • OK: Save changes and close the window
  • Cancel: Discard changes and close the window


Flow

Flow Control are useful for changin flow of execution during DragScript

DSFlowRestart.png

  • Exit Block: exit the current block container and execute the first following useful instruction
    • must be used inside a BLOCK container
    • cannot be used directly under the SCRIPT default block or EVENTS default block
    • if nested inside more than one BLOCK container DragScript Engine will exit from the first BLOCK container parent
  • Restart DragScript: The Restart DragScript element allow script to be restart from beginning, all the variable and status will be resetted
Retrieved from "https://wiki.starkeeper.it/index.php?title=DragScript_Flow_of_Control&oldid=6803"