diff options
Diffstat (limited to 'doc/kstars/scriptbuilder.docbook')
| -rw-r--r-- | doc/kstars/scriptbuilder.docbook | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/kstars/scriptbuilder.docbook b/doc/kstars/scriptbuilder.docbook index f439e662..9b5d59da 100644 --- a/doc/kstars/scriptbuilder.docbook +++ b/doc/kstars/scriptbuilder.docbook @@ -180,20 +180,20 @@ Script</guimenuitem> item in the <guimenu>File</guimenu> menu. <orderedlist> <listitem><para>Generic Device Functions: Functions to establish/shutdown devices..etc.</para> <itemizedlist> - <listitem><para><function>startINDI (QString deviceName, bool useLocal)</function> : Establish an INDI service either as local or server.</para></listitem> - <listitem><para><function>shutdownINDI (QString deviceName)</function> : Shutdown the INDI service.</para></listitem> - <listitem><para><function>switchINDI(QString deviceName, bool turnOn)</function> : Connect or Disconnect an INDI device.</para></listitem> - <listitem><para><function>setINDIPort(QString deviceName, QString port)</function> : Set the device's connection port.</para></listitem> - <listitem><para><function>setINDIAction(QString deviceName, QString action)</function> : Activate an INDI action. The action can be any <emphasis>element</emphasis> of a <emphasis>switch property</emphasis></para></listitem> - <listitem><para><function>waitForINDIAction(QString deviceName, QString action)</function> : Pause script execution until the specified action <emphasis>property</emphasis> returns with OK status.</para></listitem> + <listitem><para><function>startINDI (TQString deviceName, bool useLocal)</function> : Establish an INDI service either as local or server.</para></listitem> + <listitem><para><function>shutdownINDI (TQString deviceName)</function> : Shutdown the INDI service.</para></listitem> + <listitem><para><function>switchINDI(TQString deviceName, bool turnOn)</function> : Connect or Disconnect an INDI device.</para></listitem> + <listitem><para><function>setINDIPort(TQString deviceName, TQString port)</function> : Set the device's connection port.</para></listitem> + <listitem><para><function>setINDIAction(TQString deviceName, TQString action)</function> : Activate an INDI action. The action can be any <emphasis>element</emphasis> of a <emphasis>switch property</emphasis></para></listitem> + <listitem><para><function>waitForINDIAction(TQString deviceName, TQString action)</function> : Pause script execution until the specified action <emphasis>property</emphasis> returns with OK status.</para></listitem> </itemizedlist> </listitem> <listitem><para>Telescope Functions: Functions to control the telescope motion and status.</para> <itemizedlist> - <listitem><para><function>setINDIScopeAction(QString deviceName, QString action)</function> : Set the telescope mode or action. Available options are SLEW, TRACK, SYNC, PARK, and ABORT.</para></listitem> - <listitem><para><function>setINDITargetCoord(QString deviceName, double RA, double DEC)</function> : Set the telescope JNow target coordinates to <emphasis>RA</emphasis> and <emphasis>DEC</emphasis>.</para></listitem> - <listitem><para><function>setINDITargetName(QString deviceName, QString objectName)</function> : Set the telescope JNow target coordinates to the coordinates of <emphasis>objectName</emphasis>. KStars will lookup the object name in its database and will fetch RA and Dec once found.</para></listitem> - <listitem><para><function>setINDIGeoLocation(QString deviceName, double + <listitem><para><function>setINDIScopeAction(TQString deviceName, TQString action)</function> : Set the telescope mode or action. Available options are SLEW, TRACK, SYNC, PARK, and ABORT.</para></listitem> + <listitem><para><function>setINDITargetCoord(TQString deviceName, double RA, double DEC)</function> : Set the telescope JNow target coordinates to <emphasis>RA</emphasis> and <emphasis>DEC</emphasis>.</para></listitem> + <listitem><para><function>setINDITargetName(TQString deviceName, TQString objectName)</function> : Set the telescope JNow target coordinates to the coordinates of <emphasis>objectName</emphasis>. KStars will lookup the object name in its database and will fetch RA and Dec once found.</para></listitem> + <listitem><para><function>setINDIGeoLocation(TQString deviceName, double longitude, double latitude)</function> : Set the telescope geographical location to the longitude and latitude as specified. The longitude is measured from Greenwich, UK, to the East. However, while it is common to use negative @@ -203,26 +203,26 @@ degrees to get the value that INDI expects. For example, Calgary, Canada coordinates in &kstars; are longitude: -114 04 58; latitude: 51 02 58. So INDI's would need longitude = 360 - 114.083 = 245.917 degrees.</para></listitem> - <listitem><para><function>setINDIUTC(QString ddeviceName, QString UTCDateTime)</function> : Set the telescope UTC Date and Time in ISO 8601 format. The format is YYYY-MM-DDTHH:MM:SS (e.g. 2004-07-12T22:05:32).</para></listitem> + <listitem><para><function>setINDIUTC(TQString ddeviceName, TQString UTCDateTime)</function> : Set the telescope UTC Date and Time in ISO 8601 format. The format is YYYY-MM-DDTHH:MM:SS (e.g. 2004-07-12T22:05:32).</para></listitem> </itemizedlist> </listitem> <listitem><para>Camera/CCD Functions: Functions to control the camera/CCD properties and status.</para> <itemizedlist> - <listitem><para><function>setINDICCDTemp(QString deviceName, int temp)</function> : Set the CCD chip target temperature in degrees celsius.</para></listitem> - <listitem><para><function>setINDIFrameType(QString deviceName, QString type)</function> : Set the CCD frame type. Available options are FRAME_LIGHT, FRAME_BIAS, FRAME_DARK, and FRAME_FLAT.</para></listitem> - <listitem><para><function>startINDIExposure(QString deviceName, int timeout)</function> : Start the CCD/Camera exposure for the duration specified by <emphasis>timeout</emphasis> in seconds.</para></listitem> + <listitem><para><function>setINDICCDTemp(TQString deviceName, int temp)</function> : Set the CCD chip target temperature in degrees celsius.</para></listitem> + <listitem><para><function>setINDIFrameType(TQString deviceName, TQString type)</function> : Set the CCD frame type. Available options are FRAME_LIGHT, FRAME_BIAS, FRAME_DARK, and FRAME_FLAT.</para></listitem> + <listitem><para><function>startINDIExposure(TQString deviceName, int timeout)</function> : Start the CCD/Camera exposure for the duration specified by <emphasis>timeout</emphasis> in seconds.</para></listitem> </itemizedlist> </listitem> <listitem><para>Focuser Functions: Functions to control the focuser motion and status.</para> <itemizedlist> - <listitem><para><function>setINDIFocusSpeed(QString deviceName, QString action)</function> : Set the focuser speed. Available options are FOCUS_HALT, FOCUS_SLOW, FOCUS_MEDIUM, and FOCUS_FAST.</para></listitem> - <listitem><para><function>setINDIFocusTimeout(QString deviceName, int timeout)</function> : Set the duration in seconds for any subsequent startINDIFocus operations.</para></listitem> - <listitem><para><function>startINDIFocus(QString deviceName, int focusDir)</function> : Move the focuser either inward (focusDir = 0) or outward (focusDir = 1). The speed and duration of this operation is set by the <function>setINDIFocusSpeed()</function> and <function>setINDIFocusTimeout()</function> functions.</para></listitem> + <listitem><para><function>setINDIFocusSpeed(TQString deviceName, TQString action)</function> : Set the focuser speed. Available options are FOCUS_HALT, FOCUS_SLOW, FOCUS_MEDIUM, and FOCUS_FAST.</para></listitem> + <listitem><para><function>setINDIFocusTimeout(TQString deviceName, int timeout)</function> : Set the duration in seconds for any subsequent startINDIFocus operations.</para></listitem> + <listitem><para><function>startINDIFocus(TQString deviceName, int focusDir)</function> : Move the focuser either inward (focusDir = 0) or outward (focusDir = 1). The speed and duration of this operation is set by the <function>setINDIFocusSpeed()</function> and <function>setINDIFocusTimeout()</function> functions.</para></listitem> </itemizedlist> </listitem> <listitem><para>Filter Functions: Functions to control the filter position.</para> <itemizedlist> - <listitem><para><function>setINDIFilterNum(QString deviceName, int filter_num)</function> : Change the filter position to <varname>filter_num</varname>. The user can assign aliases to filter numbers in the <guimenuitem>Configure INDI</guimenuitem> dialog box under the <guimenu>Devices</guimenu> menu (e.g. Filter 1 = Red, Filter 2 = Green..etc).</para></listitem> + <listitem><para><function>setINDIFilterNum(TQString deviceName, int filter_num)</function> : Change the filter position to <varname>filter_num</varname>. The user can assign aliases to filter numbers in the <guimenuitem>Configure INDI</guimenuitem> dialog box under the <guimenu>Devices</guimenu> menu (e.g. Filter 1 = Red, Filter 2 = Green..etc).</para></listitem> </itemizedlist> </listitem> |