WARNING! \u2013 use the API at your own risk. It\u2019s recommended that you do not leave the amount alone while running scripts. Green Swamp Software is not responsible for any damage resulting from using the API interface.<\/p>\n\n\n\n
Running scripts requires that GSS be running and connected to the mount. You can start GSS on its own or by using other external programs that will load the GSS ASCOM driver such as CDC or SGP. Unless you\u2019re experienced with how GSS separates ASCOM commands from the API It\u2019s recommended that GSS be running on its own so no other external sources can interfere or interact with running scripts.<\/p>\n\n\n\n
GSS exposes a number of class members available to external programs and scripting languages. There are PowerShell example scripts located in the GSS Program files scripting directory. Find the installation section of this manual for directory locations.<\/p>\n\n\n\n
The example scripts we\u2019re created using the Windows 10 PowerShell ISE. To run PowerShell, type in the Windows search box \u201cPowerShell ISE\u201d and run either the 64 bit or X86 versions. You may run into problems executing scripts because of Windows security settings. There are a number of ways to correct this and you should search google for Microsoft\u2019s recommended approach. One way is to allow the current logged in user the ability to run script. The following command can be run within PowerShell by placing it on the first line and clicking execute or the run button. Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Bypass -Force;<\/p>\n\n\n\n
\/\/\/ Tells GSS not to process any AsCoM moment commands for external programs using the AsCoM driver. \n\/\/\/ <returns>bool<\/returns>\nbool AscomOn { get; set; }\n\n\n\/\/\/ Starts the AutoHome slew to home sensors\n\/\/\/ <param name=\"degreelimit\"><\/param>\n\/\/\/ <param name=\"offsetdec\"><\/param>\nvoid AutoHomeStart(int degreelimit = 100, int offsetdec = 0);\n\n\n\/\/\/ Stops Auto home from completing\nvoid AutoHomeStop();\n\n\n\/\/\/ Move axis number of micro steps, not marked as slewing\n\/\/\/ <param name=\"axis\">>axis number 1 or 2<\/param>\n\/\/\/ <param name=\"steps\">number of micro steps<\/param>\n\/\/\/ <returns>nothing<\/returns>\nvoid AxisMoveSteps(int axis, long steps);\n\n\n\/\/\/ Send a pulse command\n\/\/\/ <param name=\"axis\">Axis 1 or 2<\/param>\n\/\/\/ <param name=\"guideRate\">GuideRate degrees, 15.041\/3600*.5, negative value denotes direction<\/param>\n\/\/\/ <param name=\"duration\">length of pulse in milliseconds, always positive numbers<\/param>\n\/\/\/ <param name=\"backlashSteps\">Positive micro steps added for backlash<\/param>\n\/\/\/ <returns>nothing<\/returns>\nvoid AxisPulse(int axis, double guideRate, int duration, int backlashSteps = 0);\n\n\n\/\/\/ Goto position in degree\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"targetPosition\">position in degrees<\/param>\n\/\/\/ <returns>nothing<\/returns>\nvoid AxisGoToTarget(int axis, double targetPosition);\n\n\n\/\/\/ Slew axis based on a rate in degrees. Use this for small movements\n\/\/\/ like pulse guiding, rate changes, guiding changes, not go tos\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"rate\">rate\/sec in degrees<\/param>\n\/\/\/ <returns>nothing<\/returns>\nvoid AxisSlew(int axis, double rate);\n\n\n\/\/\/ K Slows to a stop movement of an Axis \n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\nvoid AxisStop(int axis);\n\n\n\/\/\/ L Abruptly stops movement of an Axis\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns>nothing<\/returns>\nvoid AxisStopInstant(int axis);\n\n\n\/\/\/ q Axes slews must start independently \nbool CanAxisSlewsIndependent { get; }\n\n\n\/\/\/ q Does mount support AZ\/EQ mode\nbool CanAzEq { get; }\n\n\n\/\/\/ q Does mount support dual encoders\nbool CanDualEncoders { get; }\n\n\n\/\/\/ q Does mount support half current tracking\nbool CanHalfTrack { get; }\n\n\n\/\/\/ q Does mount support home sensors\nbool CanHomeSensors { get; }\n\n\n\/\/\/ Test result if the mount can move Dec a single step in GoTo mode\nbool CanOneStepDec { get; }\n\n\n\/\/\/ Test result if the mount can move Ra a single step in GoTo mode\nbool CanOneStepRa { get; }\n\n\n\/\/\/ q Does mount support a polar LED\nbool CanPolarLed { get; }\n\n\n\/\/\/ q Does mount support PPec\nbool CanPPec { get; }\n\n\n\/\/\/ q Does mount support WiFi\nbool CanWifi { get; }\n\n\n\/\/\/ Sets the amount of steps added to Dec for reverse backlash pulse\nint DecBacklash { get; set; }\n\n\n\/\/\/ Gets the number of steps from the angle in rad\n\/\/\/ <param name=\"axis\"><\/param>\n\/\/\/ <param name=\"angleInRad\"><\/param>\n\/\/\/ <returns>Steps in rad<\/returns>\nlong GetAngleToStep(int axis, double angleInRad);\n\n\n\/\/\/ e Gets versions of axis in long format\n\/\/\/ <param name=\"axis\"><\/param>\n\/\/\/ <returns>long axis version<\/returns>\nlong GetAxisVersion(int axis);\n\n\n\/\/\/ e Gets version of axis in string readable format\n\/\/\/ <param name=\"axis\"><\/param>\n\/\/\/ <returns>string axis version as string<\/returns>\nstring GetAxisStringVersion(int axis);\n\n\n\/\/\/ j Gets current axis position in degrees\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns>Get Current Axis position as double<\/returns>\ndouble GetAxisPosition(int axis);\n\n\n\/\/\/ j Gets axis position counter\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns>Cardinal encoder count as long<\/returns>\nlong GetAxisPositionCounter(int axis);\n\n\n\/\/\/ d Gets Axis Current Encoder count\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns>count as double<\/returns>\ndouble GetEncoderCount(int axis);\n\n\n\/\/\/ Multiply the value of radians\/second by this factor to get a 32-bit integer for the set speed used by the motor board.\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns>factor used to get the speed<\/returns>\ndouble GetFactorRadRateToInt(int axis);\n\n\n\/\/\/ Inquire motor high speed ratio\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns>Ratio used to determine high speed<\/returns>\nlong GetHighSpeedRatio(int axis);\n\n\n\/\/\/ q Get Home position \n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param> \nlong GetHomePosition(int axis);\n\n\n\/\/\/ h Get Current \"goto\" target\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\ndouble GetLastGoToTarget(int axis);\n\n\n\/\/\/ i Get Current \"slew\" speed\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\nlong GetLastSlewSpeed(int axis);\n\n\n\/\/\/ Margin used to move from high speed to low speed\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns><\/returns>\nlong GetLowSpeedGotoMargin(int axis);\n\n\n\/\/\/ e Gets the complete version string\n\/\/\/ <returns><\/returns>\nstring GetMotorCardVersion(int axis);\n\n\n\/\/\/ Runs a motor test to see of axis can move one step in GoTo mode\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns>Result of each axis test<\/returns>\nbool GetOneStepIndicator(int axis);\n\n\n\/\/\/ s Inquire PEC Period \":s(*1)\", where *1: '1'= CH1, '2'= CH2, '3'= Both.\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\ndouble GetPecPeriod(int axis);\n\n\n\/\/\/ c Micro steps from target where the ramp down process begins\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\ndouble GetRampDownRange(int axis);\n\n\n\/\/\/ D Sidereal rate in axis speed\n\/\/\/ <returns><\/returns>\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\nlong GetSiderealRate(int axis);\n\n\n\/\/\/ Gets the angle in rad from amount of steps\n\/\/\/ <param name=\"axis\"><\/param>\n\/\/\/ <param name=\"steps\"><\/param>\n\/\/\/ <returns><\/returns>\ndouble GetStepToAngle(int axis, long steps);\n\n\n\/\/\/ a Steps per revolution\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns>Step Count<\/returns>\nlong GetStepsPerRevolution(int axis);\n\n\n\/\/\/ b Frequency of stepping timer\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns>Frequency of stepping timer<\/returns>\nlong GetStepTimeFreq(int axis);\n\n\n\/\/\/ The current Declination guide rate \ndouble GuideRateDeclination { get; set; }\n\n\n\/\/\/ The current Right Ascension guide rate \ndouble GuideRateRightAscension { get; set; }\n\n\n\/\/\/ F Initialize both Axes\nvoid InitializeAxes();\n\n\n\/\/\/ Is the auto home process running\nbool IsAutoHomeRunning { get; }\n\n\n\/\/\/ Is mount in a connected serial state\nbool IsConnected { get; }\n\n\n\/\/\/ Starts or Stops mount and connection\nbool IsMountRunning { get; set; }\n\n\n\/\/\/ Is mount parked\nbool IsParked { get; }\n\n\n\/\/\/ q Is the mount collecting PPec data\nbool IsPPecInTrainingOn { get; }\n\n\n\/\/\/ q Does the mount have PPec turned on\nbool IsPPecOn { get; }\n\n\n\/\/\/ j Is axis at full stop\n\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns><\/returns>\nbool IsFullStop(int axis);\n\n\n\/\/\/ j Is axis in high speed mode\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns><\/returns>\nbool IsHighSpeed(int axis);\n\n\n\/\/\/ Is mount type set to SkyWatcher\nbool IsServerSkyWatcher { get; }\n\n\n\/\/\/ f Is axis slewing normal mode\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns><\/returns>\nbool IsSlewing(int axis);\n\n\n\/\/\/ f Is axis slewing in a positive direction\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns><\/returns>\nbool IsSlewingForward(int axis);\n\n\n\/\/\/ f Is axis slewing in goto mode\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <returns><\/returns>\nbool IsSlewingTo(int axis);\n\n\n\/\/\/ Last known error from the AutoHome Process\nstring LastAutoHomeError { get; }\n\n\n\/\/\/ e Identify type of mount\nbool MountType { get; }\n\n\n\/\/\/ e Identify board version\nbool MountVersion { get; }\n\n\n\/\/\/ Park mount to the current selected park position\nvoid Park();\n\n\n\/\/\/ Get parked selected or Set to an existing park position name\nstring ParkPosition { get; set; }\n\n\n\/\/\/ Turns PPec off during movements and then back on for error correction moves\n\/\/\/ <param name=\"on\"><\/param>\nvoid SkySetAlternatingPPec(bool on);\n\n\n\/\/\/ E Reset the position of an axis\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"position\">degrees<\/param>\nvoid SetAxisPosition(int axis, double position);\n\n\n\/\/\/ M Set the break point increment\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"stepsCount\">The steps count.<\/param>\nvoid SetBreakPointIncrement(int axis, long stepsCount);\n\n\n\/\/\/ Turns on or off converting a Dec pulse guide into a Dec GoTo\n\/\/\/ <param name=\"on\"><\/param>\nvoid SetDecPulseToGoTo(bool on);\n\n\n\/\/\/ W 4-5 Turn on off encoders\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"on\"><\/param>\nvoid SetEncoder(int axis, bool on);\n\n\n\/\/\/ W 6 Enable or Disable Full Current Low speed\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"on\"><\/param>\nvoid SetFullCurrentLowSpeed(int axis, bool on);\n\n\n\/\/\/ H Set the goto target increment in steps\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"stepsCount\"><\/param>\nvoid SetGotoTargetIncrement(int axis, long stepsCount);\n\n\n\/\/\/ W 8 Reset the home position index\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\nvoid SetHomePositionIndex(int axis);\n\n\n\/\/\/ J Start motion based on previous settings\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\nvoid StartMotion(int axis);\n\n\n\/\/\/ G Set a different motion mode\n\/\/\/ <param name=\"axis\">Axis number 1 or 2<\/param>\n\/\/\/ <param name=\"func\">'0' high speed GOTO slewing,'1' low speed slewing mode,'2' low speed GOTO mode,'3' High slewing mode<\/param>\n\/\/\/ <param name=\"direction\">0=forward (CW) right, 1=backward (CCW) left, also based on observatory settings<\/param>\nvoid SetMotionMode(int axis, int func, int direction);\n\n\n\/\/\/ W 2-3 Turn on off PPec\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"on\"><\/param>\nvoid SetPPec(int axis, bool on);\n\n\n\/\/\/ W 0-1 Turn on off PPEC training\n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"on\"><\/param>\nvoid SetPPecTrain(int axis, bool on);\n\n\n\/\/\/ I Set slewing rate, seems to relate to amount of skipped step counts. \n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"stepSpeed\">StepSpeed = 1 motor step movement, higher counts means slower movements<\/param>\nvoid SetStepSpeed(int axis, long stepSpeed);\n\n\n\/\/\/ Set simulator goto rate \n\/\/\/ <param name=\"rate\">1-20<\/param>\nvoid SetSimGotoSpeed(int rate);\n\n\n\/\/\/ S Set absolute goto target \n\/\/\/ <param name=\"axis\">axis number 1 or 2<\/param>\n\/\/\/ <param name=\"position\"><\/param>\nvoid SetTargetPosition(int axis, double position);\n\n\n\/\/\/ shutdown and close the server\nvoid ShutdownServer();\n\n\n\/\/\/ UnPark mount\nvoid UnPark();\n<\/code><\/pre>\n\n\n\n